Broadcasts API
A broadcast sends one message, through the project's connector, to a segment of the project's members.
A broadcast sends one message, through the project's connector, to a segment of the project's members. It is a send, not a stored record: there is no index endpoint and no broadcast id, because nothing is persisted. What happened is reported by the broadcast.queued and broadcast.completed webhook events, which carry 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.
There is no separate read ability: knowing who a broadcast would reach is the same privilege as being able to reach them, so all three endpoints take broadcast:send.
Endpoints
/v1/projects/{project}/broadcasts/audiencesList every audienceGET/v1/projects/{project}/broadcasts/previewPreview an audiencePOST/v1/projects/{project}/broadcastsSend a broadcastRelated
How is this guide?
Last updated on