Sign in

v53

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

Create Broadcast

Create a broadcast. Provisions a private notification template for the broadcast and returns the new broadcast in the draft state. Exactly one channel is required.

post/broadcasts

Request body

namestring required

Human-readable name.

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

The single delivery channel for this broadcast.

Response

Created

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.