Send Whatsapp Template Message (V2)

Sends one or more WhatsApp template messages, with placeholders passed as named key-value pairs instead of positions.

Before you call

  • Send a messages array. Each item needs from (your connected WhatsApp number), to (customer's phone number with country code), content.templateName, content.language and content.templateData.
  • To send to a WhatsApp group, pass groupId instead of from and to.
  • Body placeholders are objects keyed by the template's variable names, e.g. [{ "name": "John" }]. Provide every variable in the body.
  • Placeholder values cannot contain newlines, tabs or more than 4 consecutive spaces.
  • Media headers need a non-empty mediaUrl. Document headers also need filename.
  • Carousel templates need templateData.cards. Each card's cardIndex must exist in the template, starting at 0.

How it works

  • Each message is checked separately. One bad message does not fail the others.
  • The response has one entry per message: status ENQUEUED with a messageId, or FAILED with an errorMessage.
  • Enqueued messages are sent in the background. Use the messageId with Get Message Status to track delivery.
  • The template must have a body or be a carousel template. Otherwise the message fails.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
messages
array of objects
required

Array of template messages. Each requires to, from, content.templateName, content.language, content.templateData

messages*
boolean

Bypass media URL validation

Responses

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