Sign in

v4

OpenAPI 3.0.02026-07-31257282489.4 KB
Engagement Whatsapp Messages

Send a whatsapp template message

Send a WhatsApp template message to a phone number with optional custom variable values. The customValues keys must match the templateVariable names from your variable mapping. In addition, the reserved keys header_image, header_video, header_document and header_media override the template's configured header media URL and do not need a variable-mapping entry. When a custom value is provided for a variable, it takes priority over the mapped field resolution and fallback value. Missing required fields or an unknown channel return 400; a send rejected by WhatsApp returns 409 with { success: false, message }.

post/engagement/whatsapp-messages/send-template

Headers

projectstring required

Request body

{"stackTrail":"paths:/engagement/whatsapp-messages/send-template:post:requestBody:content:application/json:schema:properties:customValues","oasType":"schema","type":"unknown","description":"Key-value map of template variable overrides. Keys must match the templateVariable names from your variable mapping (e.g. { \"order_number\": \"ORD-123\", \"customer_name\": \"John\" }). The reserved keys `header_image`, `header_video`, `header_document` and `header_media` override the template's header media URL."}
languageCodestring

Language code (e.g. "en_US"). Only used as a fallback: the message is sent in the language Meta reports for the template. If omitted, defaults to the contact's language, then "en_US".

templateNamestring required

Name of the WhatsApp template registered with Meta

channelIdstring required

The WhatsApp channel ID from your project

tostring required

Recipient phone number (E.164 format, e.g. "+14155552671")

Response

Ok

{"stackTrail":"paths:/engagement/whatsapp-messages/send-template:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}