API by router
Whatsapp templates
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidstatus?string|nullcategory?string|nullX-Api-Key?string|nullSuccessful Response
application/json- response
templates*array<>total*Totalcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp/templates'Example Response
{ "templates": [ { "approved_at": "2019-08-24T14:15:22Z", "body_text": "string", "buttons": [ null ], "category": "string", "channel_endpoint_id": "e494f620-7b8a-476d-9811-395c5fa96a10", "created_at": "2019-08-24T14:15:22Z", "footer_text": "string", "header_text": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "language": "string", "meta_template_id": "string", "name": "string", "rejection_reason": "string", "sample_values": {}, "status": "string", "submitted_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "total": 0}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
body_text*Body TextTemplate body with {{1}}, {{2}} placeholders
buttons?array<>|nullcategory*CategoryOne of: ('utility', 'marketing', 'authentication')
footer_text?|nullheader_text?|nulllanguage?LanguageLength
length <= 10Default
"en_US"name*NameTemplate name (lowercase, underscores)
Length
length <= 512sample_values?|Sample values for placeholders during Meta review
Successful Response
application/json- response
approved_at?|nullbody_text*Body Textbuttons?array<unknown>|nullcategory*Categorychannel_endpoint_id*Channel Endpoint IdFormat
uuidcreated_at*Created AtFormat
date-timefooter_text?string|nullheader_text?string|nullid*IdFormat
uuidlanguage*Languagemeta_template_id?string|nullname*Namerejection_reason?string|nullsample_values?|nullstatus*Statussubmitted_at?|nullupdated_at*Updated AtFormat
date-timecurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp/templates' \ -H 'Content-Type: application/json' \ -d '{ "body_text": "string", "category": "string", "name": "string"}'Example Response
{ "approved_at": "2019-08-24T14:15:22Z", "body_text": "string", "buttons": [ null ], "category": "string", "channel_endpoint_id": "e494f620-7b8a-476d-9811-395c5fa96a10", "created_at": "2019-08-24T14:15:22Z", "footer_text": "string", "header_text": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "language": "string", "meta_template_id": "string", "name": "string", "rejection_reason": "string", "sample_values": {}, "status": "string", "submitted_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}PATCH
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidtemplate_id*Template IdFormat
uuidX-Api-Key?string|nullapplication/json- body
body_text?string|nullbuttons?array<>|nullfooter_text?string|nullheader_text?string|nullsample_values?|nullSuccessful Response
application/json- response
approved_at?|nullbody_text*Body Textbuttons?array<unknown>|nullcategory*Categorychannel_endpoint_id*Channel Endpoint IdFormat
uuidcreated_at*Created AtFormat
date-timefooter_text?string|nullheader_text?string|nullid*IdFormat
uuidlanguage*Languagemeta_template_id?string|nullname*Namerejection_reason?string|nullsample_values?|nullstatus*Statussubmitted_at?|nullupdated_at*Updated AtFormat
date-timecurl -X PATCH 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "approved_at": "2019-08-24T14:15:22Z", "body_text": "string", "buttons": [ null ], "category": "string", "channel_endpoint_id": "e494f620-7b8a-476d-9811-395c5fa96a10", "created_at": "2019-08-24T14:15:22Z", "footer_text": "string", "header_text": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "language": "string", "meta_template_id": "string", "name": "string", "rejection_reason": "string", "sample_values": {}, "status": "string", "submitted_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}DELETE
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidtemplate_id*Template IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidtemplate_id*Template IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
approved_at?|nullbody_text*Body Textbuttons?array<unknown>|nullcategory*Categorychannel_endpoint_id*Channel Endpoint IdFormat
uuidcreated_at*Created AtFormat
date-timefooter_text?string|nullheader_text?string|nullid*IdFormat
uuidlanguage*Languagemeta_template_id?string|nullname*Namerejection_reason?string|nullsample_values?|nullstatus*Statussubmitted_at?|nullupdated_at*Updated AtFormat
date-timecurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/submit'Example Response
{ "approved_at": "2019-08-24T14:15:22Z", "body_text": "string", "buttons": [ null ], "category": "string", "channel_endpoint_id": "e494f620-7b8a-476d-9811-395c5fa96a10", "created_at": "2019-08-24T14:15:22Z", "footer_text": "string", "header_text": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "language": "string", "meta_template_id": "string", "name": "string", "rejection_reason": "string", "sample_values": {}, "status": "string", "submitted_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}