Skip to Content
API keys are issued to organizations with a signed BAA. Request API access →
API referenceThe Broadcast object

The Broadcast object

Broadcast campaigns and their delivery status.

Attributes

idUUIDRequired

Unique ID of the broadcast.

organization_idUUIDRequired

Organization that sent the broadcast.

statusdraft, queued, sent, partial, failedRequired

Delivery status. partial means some recipients failed.

created_attimestampRequired

When the broadcast was created.

Endpoints

MethodPathEndpoint
GET/broadcastsList broadcasts
GET/broadcasts/{broadcastId}Retrieve a broadcast
GET/broadcasts/{broadcastId}/messagesList broadcast messages
Last updated on
Remove a participantList broadcasts