List WhatsApp templates
List the WhatsApp templates of your organization or of one WhatsApp number.
Endpoint
GET/whatsapp-channel-message-templates
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | No | Organization. Results are always limited to your API key's organization. |
whatsapp_channel_id | integer | No | Templates of one WhatsApp number. Required with $client[sync] and $client[waba_scope]. |
status | string | No | APPROVED, PENDING or REJECTED. |
category | string | No | AUTHENTICATION, MARKETING or UTILITY. |
name / language | string | No | Exact template name / language code. |
available_for_conversations | boolean | No | true = templates offered in the conversation composer. |
$client[waba_scope] | boolean | No | With whatsapp_channel_id: return every template of that number's WhatsApp Business Account once, including the ones created from another number of the same account. |
$client[sync] | boolean | No | With whatsapp_channel_id: first fetch the templates from Meta, updating statuses, importing new ones and hiding deleted ones, then list. Slower; use it to refresh. |
$limit / $skip | integer | No | Pagination. Default 10, max 50. |
$sort[name] | 1 | -1 | No | Sort order. |
Request
Response
json
See The template object.
Errors
| Status | When |
|---|---|
400 Bad Request | $client[sync] without a single whatsapp_channel_id, or Meta returned an error while syncing. |
Report an issue with this documentation
Please log in to report issues with our documentation.