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

import requests

url = "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template"

payload = {
    "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"
    }
}
headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    project: '<project>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://api.gleap.io/v3/engagement/whatsapp-messages/send-template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template"

	payload := strings.NewReader("{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gleap.io/v3/engagement/whatsapp-messages/send-template")
  .header("project", "<project>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/engagement/whatsapp-messages/send-template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}"

response = http.request(request)
puts response.read_body

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

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

import requests

url = "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template"

payload = {
    "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"
    }
}
headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    project: '<project>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://api.gleap.io/v3/engagement/whatsapp-messages/send-template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/engagement/whatsapp-messages/send-template"

	payload := strings.NewReader("{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gleap.io/v3/engagement/whatsapp-messages/send-template")
  .header("project", "<project>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/engagement/whatsapp-messages/send-template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"+14155552671\",\n  \"channelId\": \"6620f1a2b3c4d5e6f7890123\",\n  \"templateName\": \"order_confirmation\",\n  \"languageCode\": \"en_US\",\n  \"customValues\": {\n    \"order_number\": \"ORD-2026-4821\",\n    \"delivery_date\": \"March 15, 2026\",\n    \"customer_name\": \"John Doe\"\n  }\n}"

response = http.request(request)
puts response.read_body

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

string

required

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

customValues

any

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.

languageCode

string

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".

Response

200 - application/json

⌘I

Getting Started

Endpoints

Send a whatsapp template message

Authorizations

Headers

Body

Response