Skip to main content
Use this endpoint to send a WhatsApp broadcast message to one or more recipients using a pre-approved template stored in your Botsify account. You supply the template name, a list of recipient user objects, and a template_data object containing any dynamic variables the template requires. Make sure the template you reference has been approved by Meta before sending — unapproved templates will result in a delivery failure. Authentication is handled via the apikey field or the X-Api-Key header.

​
Request

​
string
required
Your bot’s API key. You may alternatively supply this value in the X-Api-Key request header instead of the body.
​
integer
required
A numeric identifier representing the message type. Refer to your Botsify account settings or template configuration for the correct value.
​
string
required
The name of the approved WhatsApp template to use for this broadcast (e.g., welcome_message).
​
array of objects
required
An array of recipient user objects. Each object should include the user’s phone number or identifier needed to route the message (e.g., {"phone": "+1234567890"}).
​
object
required
A key-value object containing the dynamic variable values to inject into the template placeholders. Keys must match the variable names expected by the template.

​
Example Request

​
Response

A successful request returns a JSON object confirming the broadcast was dispatched. The response includes a broadcast identifier you can use to retrieve delivery reports, along with the number of recipients targeted.