Send Template Whatsapp Message to Broadcast Group

Send a WhatsApp template to every member of a broadcast group, or to a list of numbers you pass in to.

Before you call

  • content.templateName and content.language must match a template that exists on the sending number.
  • from is optional: the WhatsApp number to send from, with country code. It must be connected. If left out, your account's WhatsApp number is used.
  • groupName is required. If no group has that name, a new group is created.
  • Each to entry needs a phone with country code; name is optional.
  • Placeholders you can use in templateData: {{Name}}, {{Phone Number}} and {{<Custom Field Name>}} for customer-level custom fields. A custom field placeholder only works correctly if that field is set for all customers in the group.
  • Multi-select custom fields cannot be used as variables.

How it works

  • Numbers in to are saved as customers and added to the group, and the broadcast goes to them. Invalid numbers are skipped.
  • Without to, the broadcast goes to all current group members. An empty group is rejected.
  • The broadcast is queued. The response gives the broadcast's messageId and a status.
  • messageId is optional (UUID v4). Resending the same messageId returns the existing broadcast instead of sending it again.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the WhatsApp group to send the message to

string
length between 10 and 15

The phone number from which the message is sent, with the country code

content
object
Responses

400

Bad request, invalid input provided

401

Invalid or missing API key

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json