Broadcasts API

A broadcast sends one message, through the project's connector, to a segment of the project's members. Every send is kept as a record: the send answers with its broadcast_id, the listing and the single read report how far it got and who it could not reach, and what happened is also reported by the broadcast.queued and broadcast.completed webhook events, which carry the same id beside the audience and the delivery tallies.

A broadcast cannot be recalled. Every recipient is a real person and the message arrives in their private chat. Size the audience with the preview endpoint before you send; a segment that silently resolves to everyone is the one mistake this API cannot undo.

Sending, previewing and listing the audiences take broadcast:send: knowing who a broadcast would reach is the same privilege as being able to reach them. Reading the history takes broadcast:read; a token minted with * holds both, a token with named abilities is re-issued to read it.

EndpointsCopy Anchor Link

Related

broadcast.* eventsReact to sends and their outcomes.BroadcastsThe same feature in the dashboard.ZapierAnd [n8n](https://docs.subscriby.net/integrations/n8n): send broadcasts without writing code.