List available message templates
GET
/v1/whatsapp/templates
curl -X GET "https://us1.platform.bird.com/v1/whatsapp/templates" \
-H "Authorization: Bearer $TOKEN"Returns the message templates available to this workspace.
Payload de resposta
data
array of object
obrigatório
The templates available to your workspace.
Mostrar atributos secundários
data.name
string
obrigatório
The template's stable handle. Pass it as the template reference when sending.
data.scope
string
obrigatório
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
data.language
string
obrigatório
The language code of this template variant (for example en or pt_BR).
data.category
object
obrigatório
Content classification applied to messages sent from this template.
data.status
object
obrigatório
The template's review and health status.
data.components
array of object
obrigatório
The content blocks that make up the template, in display order.
Mostrar atributos secundários
data.components.type
string
obrigatório
The content block's type within the template.
data.components.text
string
The block's text content, with any variable placeholders shown inline. Present when the block carries text.
data.components.example_parameters
array of object
Example values for this block's variables, in placeholder order — one per {{n}}. Use them to see what a filled message looks like. Present when the block has variables.
Mostrar atributos secundários
data.components.example_parameters.type
object
obrigatório
The kind of value this parameter accepts.
data.components.example_parameters.text
string
An example value for a text parameter. Present when type is text.
data.components.buttons
array of object
The buttons attached to this block. Present when the block carries buttons.
Mostrar atributos secundários
data.components.buttons.type
string
obrigatório
The button's behavior type.
data.components.buttons.text
string
obrigatório
The button's label text.
data.components.buttons.url
string
The URL the button opens, with any variable placeholder shown inline. Present on link buttons.
data.components.buttons.example_parameters
array of object
Example values for this button's variables, in placeholder order. Present when the button URL has variables.
Mostrar atributos secundários
data.components.buttons.example_parameters.type
object
obrigatório
The kind of value this parameter accepts.
data.components.buttons.example_parameters.text
string
An example value for a text parameter. Present when type is text.