WhatsApp templates

WhatsApp message templates approved by Meta for your WhatsApp numbers. Templates are needed to write to a contact outside WhatsApp's 24-hour window; send one with Send a WhatsApp template. Templates are created, edited and deleted in the AchieveApex app or in Meta's WhatsApp Manager; the API reads them.

Endpoints

MethodPathDescription
GET/whatsapp-channel-message-templatesList WhatsApp templates
GET/whatsapp-channel-message-templates/:idGet a WhatsApp template

The template object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID. Send it as template_id.
organization_idintegerOrganization.
whatsapp_channel_idintegerWhatsApp number the template was created or imported from. The template can be sent from any number of the same WhatsApp Business Account.
whatsapp_template_idstring | nullTemplate ID in Meta.
namestringTemplate name in Meta.
languagestringLanguage code, e.g. en_US, es.
categorystringAUTHENTICATION, MARKETING or UTILITY.
statusstringReview status: APPROVED, PENDING or REJECTED. Only approved templates are delivered.
componentsarrayTemplate components in Meta's format (HEADER, BODY, FOOTER, BUTTONS), with {{n}} placeholders.
variables_matchingobject | nullMaps each placeholder (body_1, header_1, ...) to the variable that fills it: a contact field such as contact_first_name, or a custom variable such as custom_body_2 that you pass in custom_variables when sending.
available_for_conversationsbooleanShown in the conversation composer.
available_for_campaignsbooleanAvailable for WhatsApp campaigns.
meta_status_updateobject | nullLast status change notification received from Meta (for example the rejection reason).
created_atstring (date-time)Read-only.
updated_atstring (date-time)Read-only.
deleted_atstring (date-time) | nullRead-only. Set when the template was deleted (in the app or in Meta).

Report an issue with this documentation

Please log in to report issues with our documentation.