Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Path Parameters

broadcast_id
string
required

Id of the broadcast, returned when it was created via POST /message/broadcast

Minimum string length: 1
Example:

"00000000-0000-0000-0000-000000000000"

Response

The outcome of the cancellation

broadcast_id
string

Id of the affected broadcast

Example:

"00000000-0000-0000-0000-000000000000"

status
enum<string>

Outcome: 'deleted' when the broadcast had not started (removed entirely, credits never debited); 'stopped' when it was in progress (remaining messages cancelled and their credits refunded)

Available options:
deleted,
stopped
Example:

"stopped"