TEASEDocs
API ReferenceInbox & Broadcasts

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.

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.

Response Body

application/json

application/json

application/json

GET
/api/admin/broadcasts/{campaign_id}
curl -X GET "https://example.com/api/admin/broadcasts/0"
{  "id": 42,  "title": "Weekend whale push",  "mode": "tiered",  "status": "scheduled",  "stats": {    "planned_sends": 1000,    "sent": 0,    "revenue_cents": 0  }}
{  "detail": "Not authenticated"}
{  "detail": "campaign not found"}

Preview a broadcast audience

Estimates how many fans an audience selector matches before scheduling, returning matched/selected counts and a non-PII distribution. Does not create or send anything. Requires a read-scoped key.

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.