Skip to main content
POST
Send a broadcast

Authorizations

Authorization
string
header
required

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

Path Parameters

groupId
string
required

ID of the contact group. List groups with GET /api/v1/contact-groups to find it.

Example:

"cmbxh1a2b0004ph01q8r9s0t1"

Body

application/json
templateName
string
required

Name of an approved WhatsApp template in this workspace.

Maximum string length: 512
Example:

"order_status_update"

language
string
default:en_US

Template language code.

Example:

"en_US"

parameters
string[]

Values for the template's {{1}}, {{2}}, … placeholders, in order. The same values are used for every recipient.

Maximum string length: 1024
Example:

Response

Broadcast processed

broadcast
object