Send a pre-approved template message
POST
/events
messaging
Request
Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
event_type
enum<string>
required
Allowed value:
send_template_message
contact
object (Contact)
required
name
string
optional
Example:
Alfred Hitchcock
email
string
optional
Example:
alfred@example.com
phone_number
string
required
Example:
+19019019191 or +919876543210
template_message
object
required
whats_app_template_id
string
required
Example:
your_template_id
liquid_values
object
optional
Example:
{"product_name":"Product 1","price":112,"currency":"₹"}
retry_until
string
optional
Example:
2024-04-01T17:30:00Z
retry_window
object
optional
Example
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/events' \
--header 'Content-Type: application/json' \
--data-raw ''
Responses
🟢201Created
application/json
Body
event_type
enum<string>
required
Allowed value:
send_template_message
contact
object (Contact)
required
name
string
optional
Example:
Alfred Hitchcock
email
string
optional
Example:
alfred@example.com
phone_number
string
required
Example:
+19019019191 or +919876543210
template_message
object
required
whats_app_template_id
string
required
Example:
your_template_id
liquid_values
object
optional
Example:
{"product_name":"Product 1","price":112,"currency":"₹"}
retry_until
string
optional
Example:
2024-04-01T17:30:00Z
retry_window
object
optional
Example
{
"event_type": "send_template_message",
"contact": {
"name": "Alfred Hitchcock",
"email": "alfred@example.com",
"phone_number": "+19019019191 or +919876543210"
},
"template_message": {
"whats_app_template_id": "your_template_id",
"liquid_values": {
"product_name": "Product 1",
"price": 112,
"currency": "₹"
},
"retry_until": "2024-04-01T17:30:00Z",
"retry_window": {
"start_at": "08:00",
"end_at": "20:00",
"timezone": "The account's default timezone"
}
}
}
🟠422Parameter Error
Modified at 2025-02-22 07:36:01