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.

Headers

x-phone
string
required

Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token.

Minimum string length: 1
Example:

"919876543210"

Body

application/json
queue_ids
string[]

Queue job ids to remove from the queue

Example:
broadcast_id
string

Remove every queued job belonging to this broadcast

Example:

"00000000-0000-0000-0000-000000000000"

Response

Confirmation of the purge

purged
enum<boolean>

Always true when the purge request was accepted

Available options:
true
mode
enum<string>

What was purged: 'queue_ids' when specific jobs were targeted, 'broadcast' when a broadcast's jobs were targeted, 'all' when neither filter was given and the entire queue was purged

Available options:
all,
queue_ids,
broadcast
Example:

"queue_ids"

queue_ids
string[]

Echo of the queue_ids filter, present only when it was sent

Example:
broadcast_id
string

Echo of the broadcast_id filter, present only when it was sent