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
| Method | Path | Description |
|---|---|---|
GET | /whatsapp-channel-message-templates | List WhatsApp templates |
GET | /whatsapp-channel-message-templates/:id | Get a WhatsApp template |
The template object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. Send it as template_id. |
organization_id | integer | Organization. |
whatsapp_channel_id | integer | WhatsApp number the template was created or imported from. The template can be sent from any number of the same WhatsApp Business Account. |
whatsapp_template_id | string | null | Template ID in Meta. |
name | string | Template name in Meta. |
language | string | Language code, e.g. en_US, es. |
category | string | AUTHENTICATION, MARKETING or UTILITY. |
status | string | Review status: APPROVED, PENDING or REJECTED. Only approved templates are delivered. |
components | array | Template components in Meta's format (HEADER, BODY, FOOTER, BUTTONS), with {{n}} placeholders. |
variables_matching | object | null | Maps 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_conversations | boolean | Shown in the conversation composer. |
available_for_campaigns | boolean | Available for WhatsApp campaigns. |
meta_status_update | object | null | Last status change notification received from Meta (for example the rejection reason). |
created_at | string (date-time) | Read-only. |
updated_at | string (date-time) | Read-only. |
deleted_at | string (date-time) | null | Read-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.