Broadcasts
Built-in actions for marketing and transactional broadcasts
List Broadcasts
BroadcastsList the broadcasts in this organization, newest first. MARKETING broadcasts are bulk sends to segments or all contacts; TRANSACTIONAL broadcasts are single-recipient sends fired by triggers or the API.
Get Broadcast
BroadcastsRead a single broadcast in full: status, schedule, audience (segments or all contacts), channel templates and delivery counters (sent, delivered, opened, failed).
Create Broadcast
BroadcastsCreate a broadcast as a DRAFT: a bulk marketing campaign (e.g. a WhatsApp template blast) to segments or all contacts, or a transactional single-recipient send.
Update Broadcast
BroadcastsUpdate a broadcast name, schedule time or audience. Audience and schedule can only change while the broadcast is editable (marketing: DRAFT, CANCELLED or FAILED; transactional: DRAFT, ACTIVE or PAUSED).
Duplicate Broadcast
BroadcastsCopy a broadcast including its segments and channel templates. The copy is created as a DRAFT and does not send anything.
Delete Broadcast
BroadcastsPermanently delete a broadcast and its delivery history. Marketing broadcasts cannot be deleted while scheduled or sending; transactional ones must be paused first.
Schedule Broadcast
BroadcastsQueue a MARKETING broadcast for delivery to its full audience. Sends immediately when the broadcast has no scheduled time, otherwise waits for it. This is the real mass send: confirm with the user before calling it. Requires DRAFT, CANCELLED or FAILED status and at least one channel template.
Cancel Broadcast
BroadcastsCancel a MARKETING broadcast in SCHEDULED or SENDING status. Recipients already sent stay sent; the rest are skipped.
Activate Broadcast
BroadcastsActivate a TRANSACTIONAL broadcast so it accepts triggers and starts sending to individual recipients. Allowed from DRAFT or PAUSED; requires at least one channel template.
Pause Broadcast
BroadcastsPause an ACTIVE transactional broadcast. Triggers are rejected until it is activated again; configuration is preserved.
Send Broadcast Test
BroadcastsSend a test of a broadcast to a single email address or phone number so its content can be reviewed before the real send. Only works while the broadcast is testable (marketing: DRAFT, CANCELLED or FAILED; transactional: DRAFT, ACTIVE or PAUSED).
Get Broadcast Analytics
BroadcastsAggregated delivery and engagement stats per broadcast: totals, delivery rate and open rate, optionally limited to a date range.
List Broadcast Recipients
BroadcastsList individual broadcast deliveries with their status (sent, delivered, opened, failed, bounced). Answers "did we send X to this contact": filter by broadcast, by contact, or search by name, email or phone across all broadcasts.