Skip to main content

​
Prepare a draft

Use an active tenant phone and an approved template in its WABA cache. POST /v1/broadcasts requires name, phoneNumberId, templateName, templateLanguage and recipients. Provide 1–500 numbers, preferably digits only without +. Duplicates are removed. Optional templateComponents are shared by all recipients, not personalized per recipient. Creation produces a draft and sends nothing.

​
Send deliberately

POST /v1/broadcasts/{broadcastId}/send starts a real campaign. Review recipients, template and parameters first.
The send call moves draft to queued; sending happens in the background. The immediate response is not a final delivery report. A non-draft cannot be sent again.

​
Follow progress

GET /v1/broadcasts/{broadcastId} returns the broadcast and recipients. States include draft, queued, sending, completed, cancelled, failed. This does not imply a public cancellation endpoint exists. Recipient counts use pending, sent, failed, skipped; empty statuses may be omitted. sent does not mean delivered or read: use status webhooks. GET /v1/broadcasts lists the latest 100, newest first.