Send Template Message
Send approved WhatsApp templates with dynamic parameters
Reading time: 1 minute
Send Template Message
Send approved WhatsApp templates with dynamic parameters.
POST
{{base_url}}/w/message/templateContent-Type: multipart/form-data
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
phone_number_id | string | Yes | Phone number ID of the sender |
Request Body (form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | integer | Yes | Template ID |
phone | string | Yes | Recipient phone number |
header_type | string | Yes | Header type: TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION |
header_value | string | No | Header value (URL for media, text for text) |
header_media | file | No | Media file for header |
body_params | JSON | No | Message text parameters (JSON string) |
button_params | JSON | No | Button parameters (JSON string) |
Parameter Types:
WhatsApp supports two types of parameters:
- NAMED: Parameters with specific names
{name: "offer_code", value: "SUMMER25"} - POSITIONAL: Parameters by order
["Mohammed", "2025-06-30"]
Example 1: Named Parameters (NAMED)
Example 1: Named Parametersbash
curl -X POST "{{base_url}}/w/message/template?phone_number_id=123456" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id" \
-F "template_id=2" \
-F "phone=96650000000" \
-F "header_type=IMAGE" \
-F "header_value=https://example.com/offer-banner.jpg" \
-F "body_params=[{\"name\": \"offer_code\", \"value\": \"SUMMER25\"}, {\"name\": \"expiry_date\", \"value\": \"2025-06-30\"}]" \
-F "button_params=[{\"index\": 0, \"name\": \"offer_id\", \"value\": \"12345\"}]"Example 2: Positional Parameters (POSITIONAL)
Example 2: Positional Parametersbash
curl -X POST "{{base_url}}/w/message/template?phone_number_id=123456" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id" \
-F "template_id=11" \
-F "phone=96650000000" \
-F "header_type=TEXT" \
-F "header_value=Hello {{1}}" \
-F "body_params=[\"Ahmed Mohammed\", \"12345\", \"150 SAR\"]"Related
ā Back to Messages
View Guide