Send WhatsApp template with buttons

Send an approved WhatsApp Business template that has buttons. The request has the same shape as Send WhatsApp text template, with one more section in template_variables: buttons.

Button variables. buttons is a list with one item per button, in the order the template lists them: the first item is the first button. Each item holds that button's values, for example the changing part of a link: "buttons": [ { "1": "track-1001" } ]. A button without a placeholder (quick reply, fixed link) needs no item; use {} in its place only when a later button has one.

sender is the WhatsApp Business number the template is sent from; it defaults to the channel's sender. A variable the template declares but you leave out is sent as a blank space, so the message still goes out — check your variables.

Template variables. template_variables has up to three sections. Send only the ones your template has placeholders in:

  • header: values for a text header, { "1": "4821" }.
  • body: values for the body text, { "1": "John", "2": "4821" }. A named placeholder such as {{first_name}} is keyed by its name: { "first_name": "John" }.
  • buttons: a list with one item per button, in the template's button order: [ { "1": "track-1001" } ].

Response. HTTP 200 with a task_id and one entry per message. status is false when any message failed: failed entries come first and carry error (hex code) and details; accepted entries carry message_uuid (and conversation_uuid on two-way channels). Match entries by internal_id. Final delivery status is sent asynchronously to your configured webhook.

Authentication: channel token in the Authorization header (see Authentication in the API Overview).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

WhatsApp Business sender phone number. Defaults to the channel's sender.

The approved WhatsApp template, by its eventKey on the channel. Required unless every recipient sets event.

recipients
array of objects
required
length ≤ 250

The recipients, up to 250 per request.

Recipients*
Responses

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