TEASEDocs
API ReferenceInbox & Broadcasts

Edit a broadcast campaign

Updates the title, audience, message, or schedule of a draft campaign. Only the provided fields are changed. 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 edit.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

PATCH
/api/admin/broadcasts/{campaign_id}
curl -X PATCH "https://example.com/api/admin/broadcasts/0" \  -H "Content-Type: application/json" \  -d '{    "title": "Weekend whale push v2",    "message": {      "text": "last chance 💕",      "price_cents": 3000    }  }'
{  "id": 42}
{  "detail": "Not authenticated"}
{  "detail": "campaign not found"}

Get a broadcast campaign with stats

Returns one campaign with its delivery/ROI rollup and, for drip campaigns, the per-step funnel. Requires a read-scoped key.

Schedule a broadcast

Expands a draft campaign into a paced send plan and schedules it. Sends are screened, paced, and behind an off-by-default delivery gate, so scheduling produces the plan but does not deliver until the gate is live. Requires a write-scoped key.