Skip to main content
POST
Send a broadcast to an audience

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Body

application/json
templateName
string
required

Name of an approved WhatsApp template.

Maximum string length: 512
Example:

"order_status_update"

audience
object
required

Who to send to. Exactly one shape.

language
string
default:en_US
Example:

"en_US"

parameters
string[]

Default {{1}}, {{2}}, … values for group/contacts/filter audiences. Ignored for recipients rows that carry their own values.

Maximum string length: 1024
Example:

Response

Broadcast processed

broadcast
object