TEASEDocs
API ReferenceInbox & Broadcasts

Pause a broadcast

Pauses a scheduled or running campaign; no further sends are made until it is resumed. Requires a write-scoped key.

Authorization

bearerAuth
AuthorizationBearer <token>

Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.

In: header

Path Parameters

campaign_id*integer

Identifier of the campaign to pause.

Response Body

application/json

application/json

application/json

POST
/api/admin/broadcasts/{campaign_id}/pause
curl -X POST "https://example.com/api/admin/broadcasts/0/pause"
{  "ok": true}
{  "detail": "Not authenticated"}
{  "detail": "campaign not found"}