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

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/whatsapp-messages/send-template
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

customValuesunknown
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

unknown required

Changes

No recorded changes to this operation across all 56 revisions of this API.