List WhatsApp templates

List the WhatsApp templates of your organization or of one WhatsApp number.

Endpoint

GET
/whatsapp-channel-message-templates

Query parameters

NameTypeRequiredDescription
organization_idintegerNoOrganization. Results are always limited to your API key's organization.
whatsapp_channel_idintegerNoTemplates of one WhatsApp number. Required with $client[sync] and $client[waba_scope].
statusstringNoAPPROVED, PENDING or REJECTED.
categorystringNoAUTHENTICATION, MARKETING or UTILITY.
name / languagestringNoExact template name / language code.
available_for_conversationsbooleanNotrue = templates offered in the conversation composer.
$client[waba_scope]booleanNoWith 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]booleanNoWith 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 / $skipintegerNoPagination. Default 10, max 50.
$sort[name]1 | -1NoSort order.

Request

Response

json

See The template object.

Errors

StatusWhen
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.