Broadcasts

Built-in actions for marketing and transactional broadcasts

List Broadcasts

List the broadcasts in this organization, newest first.

Get Broadcast

Read a single broadcast in full: status, schedule, audience (segments or all contacts), channel templates and delivery counters (sent, delivered, opened, failed).

Create Broadcast

Create a broadcast as a DRAFT: a bulk marketing campaign (e.g.

Update Broadcast

Update a broadcast name, schedule time or audience.

Duplicate Broadcast

Copy a broadcast including its segments and channel templates.

Delete Broadcast

Permanently delete a broadcast and its delivery history.

Set Broadcast State

Move a broadcast through its lifecycle: 'schedule' queues a MARKETING broadcast for its full audience (the real mass send — immediately, or at its scheduled time; requires a channel template); 'cancel' stops a scheduled/sending marketing broadcast and returns it to draft; 'activate' turns a TRANSACTIONAL broadcast on; 'pause' suspends it.

Set Broadcast Channel Template

Attach or update the channel message of a broadcast — what actually gets sent.

Add Broadcast Recipients

Add specific contacts to a MARKETING broadcast audience (on top of segments / send-to-all), e.g.

Get Broadcast Recipient Counts

Preview how many recipients a MARKETING broadcast will reach per channel, based on its current audience — check this before scheduling the send.

Retry Broadcast Recipients

Retry the failed recipients of a broadcast (up to 1000 per call).

Remove Broadcast Recipients

Remove pending (not yet sent) recipients from an editable MARKETING broadcast.

List Broadcast Fields

List the personalization fields ({{variable}} placeholders) of a broadcast with their default values.

Set Broadcast Field

Create or update a personalization field ({{variable}}) on a broadcast with its default value.

Set Broadcast Field Entries

Set per-recipient personalization values on a MARKETING broadcast.

Schedule Broadcast

Queue a MARKETING broadcast for delivery to its full audience.

Cancel Broadcast

Cancel a MARKETING broadcast in SCHEDULED or SENDING status: it returns to DRAFT and can be edited and re-scheduled.

Activate Broadcast

Activate a TRANSACTIONAL broadcast so it accepts triggers and starts sending to individual recipients.

Pause Broadcast

Pause an ACTIVE transactional broadcast.

Send Broadcast Test

Send a test of a broadcast to a single email address or phone number so its content can be reviewed before the real send.

Get Broadcast Analytics

Aggregated delivery and engagement stats per broadcast: totals, delivery rate and open rate, optionally limited to a date range.

List Broadcast Recipients

List individual broadcast deliveries with their status (sent, delivered, opened, failed, bounced).