POST WhatsApp Template Message
API to send the WhatsApp template message
Parameter Description
userName
: refers to the name of the user we intend to send the messagewa_id
: refers to the WhatsApp number of the user we intend to send the message NOTE: The number must contain the country code without the plus signtemplateId
: refers to the ID of the template NOTE: Template must be approved before using this APIassingTo
: refers to the email of custom user or agent.params
: is used for the variables used in the template, it is an empty array in the case of a plain text template with no variables. In case of variables in the template, please refer to the JSON belowtags
: refers to label you can assign to conversations or chats to help organize and manage effectively.
API End Points
https://api-v7.express-chat.com/whatsapp-automation/wa/templates?apiKey=*API KEY*
Request Headers
apiKey
API KEY
Query Params
apiKey
API KEY
Body
{
"userName": "Divyansh Test",
"wa_id": "9175080****",
"templateId": "62b5c16bf*****cfa9a72335",
"params": [
{
"type" : "header",
"parameters": [
{
"type": "document",
"document": {
"link": "<https://www.africau.edu/images/default/sample.pdf>"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Abc"
},
{
"type": "text",
"text": "def"
},
{
"type": "text",
"text": "Monday"
}
]
}
],
"assignTo": "example@gmail.com",
"tags": [ "test" ]
}
Example:
Request
curl --location --request POST '<https://api-v7.express-chat.com/whatsapp-automation/wa/send-template?apiKey=> *Shared Separately*' \\
--header 'apiKey: *API KEY*' \\
--header 'Content-Type: application/json' \\
--data-raw '{
"userName": "Test",
"wa_id": "91885917****",
"templateId": "63dba1617****52face07078",
"params": [
{
"type": "header",
"parameters": [
{
"type": "document",
"document": {
"link": "<https://www.africau.edu/images/default/sample.pdf>"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Abc"
},
{
"type": "text",
"text": "def"
},
{
"type": "text",
"text": "Monday"
}
]
}
],
"assignTo": "example@gmail.com",
"tags": [ "test" ]
}'
Response
Header
X-Powered-By
Express
Vary
Origin
Access-Control-Allow-Credentials
true
_user
61c1c2058e0****e9bb420f8
_bot
62e77a807f1****ecce980f0
whatsAppId
****bsIWcYgazd5ZDAK
Content-Type
application/json; charset=utf-8
Content-Length
507
Etag
W/"1fb-urlVjgGZAUBRNyxQDAOnZ3ONF1I"
Date
Wed, 03 Aug 2022 11:16:13 GMT
Connection
keep-alive
Keep-Alive
timeout=5
Last updated
Was this helpful?