Broadcasts
Template campaigns to many recipients.
The broadcast object
As returned by GET /broadcasts, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
namerequired | string | Campaign name, as shown in the dashboard |
kindrequired | string (enum) | template = an approved WhatsApp template; free_text = a personal-WhatsApp messagetemplatefree_text |
channelrequired | string | whatsapp | personal_whatsapp |
templaterequired | object | null | The template a template broadcast sends |
template.namerequired | string | |
template.languagerequired | string | |
statusrequired | string (enum) | draft → scheduled → sending → sent | faileddraftscheduledsendingsentfailed |
scheduled_atrequired | string (date-time) | null | When it was (or will be) started |
countsrequired | object | Live delivery counters — poll this endpoint for progress |
counts.totalrequired | integer | Recipients materialised |
counts.sentrequired | integer | Handed to the channel |
counts.deliveredrequired | integer | Confirmed delivered to the handset |
counts.readrequired | integer | Confirmed read |
counts.repliedrequired | integer | Recipients who replied |
counts.failedrequired | integer | Rejected by the channel |
created_atrequired | string (date-time) | ISO 8601 timestamp |
updated_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
5 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.