API ReferenceInbox & Broadcasts
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.
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 schedule.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/admin/broadcasts/0/schedule"{ "planned_sends": 1000, "status": "scheduled"}{ "detail": "Not authenticated"}{ "detail": "campaign not found"}{ "detail": "audience is empty"}