Skip to main content

Manage WhatsApp Templates

Get Templates​

GET /v2/accounts/<account_sid>/templates

Query Parameters​

ParameterRequiredDescription
waba_idYesWhatsApp Business Account ID
nameNoFilter by template name
statusNoFilter by status
languageNoFilter by language
categoryNoFilter by category
limitNoResults per page
before / afterNoPagination cursors

Upload Template Sample​

Upload media files for use in templates.

POST /v2/accounts/<account_sid>/templates/sample?file_length=<bytes>&file_type=<type>

Supported types: application/pdf, image/jpeg, image/png, video/mp4

Returns a file_handle ID for use in template creation.


Create Template​

POST /v2/accounts/<account_sid>/templates

Request Body​

{
"whatsapp": {
"templates": [{
"template": {
"category": "TRANSACTIONAL",
"name": "order_update",
"language": "en",
"components": [
{ "type": "HEADER", "format": "TEXT", "text": "Order Update" },
{ "type": "BODY", "text": "Your order {{1}} has been {{2}}." },
{ "type": "FOOTER", "text": "Thank you for shopping!" }
]
}
}]
}
}

Edit Template​

PUT /v2/accounts/<account_sid>/templates

Include the id field in the template object to identify which template to update.


Delete Template​

DELETE /v2/accounts/<account_sid>/templates?waba_id=<id>

Request Body​

{
"whatsapp": {
"templates": [{
"template": { "name": "template_name" }
}]
}
}

HTTP Status Codes​

CodeDescription
200Success
400Bad Request
401Unauthorized
402Payment Required
403Access Denied
404Not Found