Skip to main content
TypeScript
Deprecated. Use POST /message/queues/purge instead. The request body shape is the same, queue_ids and broadcast_id are accepted

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
broadcast_id
string

Purge every queued job belonging to this broadcast

Minimum string length: 1
Example:

"00000000-0000-0000-0000-000000000000"

queue_id

Queue job id (the id field of a queue job), or an array of them, of the specific jobs to purge

Example:

Response

Jobs purged — no content