Skip to content
Pidgely Docs

API reference · Broadcasts

Cancel a broadcast

POSThttps://api.pidgely.com/broadcasts/{id}/cancel
View as Markdown

Cancels a broadcast that is scheduled or queued. A broadcast that is already sending cannot be canceled.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Resource id UUID.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.broadcasts.cancel('0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19');
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Broadcasts.cancel("0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19")
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->broadcasts->cancel('0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19');
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Broadcasts.Cancel(ctx, "0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19")
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Broadcasts.cancel("0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19")
puts result
cURL
curl -X POST 'https://api.pidgely.com/broadcasts/0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19/cancel' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "broadcast",
  "id": "0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19"
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
409 broadcast_not_cancelable The broadcast is not scheduled or queued.