Sign in

v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Broadcasts

Schedule Broadcast

Schedule a broadcast for a future send to a list or audience. Publishes the broadcast template first. Not allowed once the broadcast is sending or sent. For an immediate send use POST /broadcasts/{broadcastId}/send.

post/broadcasts/{broadcastId}/schedule

Path parameters

broadcastIdstring required

Request body

recipient_type'list' | 'audience' required

Whether the broadcast targets a list or an audience.

recipient_idstring required

ID of the target list or audience.

scheduled_tostring required

Wall-clock timestamp of the future send, no timezone offset (e.g. "2026-07-21T20:00:00"). The zone is given by timezone.

timezonestring

IANA timezone for the scheduled send (e.g. America/New_York).

Response

idstring required

The broadcast ID (bst_ prefix).

namestring required

Human-readable name.

channel'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams' required

The broadcast's delivery channel.

status'draft' | 'scheduled' | 'sending' | 'sent' required

Lifecycle status of the broadcast.

created_atstring required

ISO 8601 timestamp when the broadcast was created.

updated_atstring required

ISO 8601 timestamp of the last update.

created_bystring required

Actor that created the broadcast.

updated_bystring required

Actor that last updated the broadcast.

archived_atstring nullable

ISO 8601 timestamp when the broadcast was archived, if archived.

archived_bystring nullable

Actor that archived the broadcast, if archived.