Whatsapp template

Send an approved WhatsApp Business template message to one or more recipients. Identify the template with event, and supply its variables per recipient by section: HEADER, BODY and BUTTONS.

sender is the WhatsApp Business number the template is sent from; it defaults to the stream'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.

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: stream 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 stream's sender.

The approved WhatsApp template, by its eventKey on the stream. 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