Skip to main content
POST
/
engagement
/
whatsapp-messages
/
send-template
Send a whatsapp template message
curl --request POST \
  --url https://api.gleap.io/v3/engagement/whatsapp-messages/send-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'project: <project>' \
  --data '
{
  "to": "+14155552671",
  "channelId": "6620f1a2b3c4d5e6f7890123",
  "templateName": "order_confirmation",
  "languageCode": "en_US",
  "customValues": {
    "order_number": "ORD-2026-4821",
    "delivery_date": "March 15, 2026",
    "customer_name": "John Doe"
  }
}
'

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project
string
required

Body

application/json
templateName
string
required

Name of the WhatsApp template registered with Meta

channelId
string
required

The WhatsApp channel ID from your project

to
string
required

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

customValues
object

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" })

languageCode
string

Language code (e.g. "en_US"). Falls back to the contact's language or "en_US"

Response

200 - application/json

Ok