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 WhatsApp message templates you can send from. Each entry carries the template's name (the reference you pass when sending), its language, category, review status, and its content blocks with example values for every placeholder. The catalogue is returned in full, so this list is not paginated, and it can differ by region: you see the templates stocked for the region you call. Pick a template here, then fill its placeholders in the components of Send a WhatsApp message.
Response Payload
data
array of object
required
The templates available to your workspace.
Show child attributes
data.id
object
required
Stable Bird identifier for the template.
data.name
object
required
The template's stable handle. Pass it as the template reference when sending.
data.description
nullable string
Optional description of the template's purpose. Null when unset.
data.scope
string
required
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
Possible values: system, workspace
data.language
object
required
data.category
object
required
Content classification applied to messages sent from this template.
data.status
object
required
The template's review and health status.
data.components
array of object
required
The content blocks that make up the template, in display order.
Show child attributes
data.components.type
string
required
The content block's type within the template.
Possible values (may grow over time): header, body, footer, buttons
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.
Show child attributes
data.components.example_parameters.type
object
required
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.example_parameters.name
string
The named placeholder this example fills, for templates that use named parameters. Absent for system templates, which use positional parameters.
data.components.buttons
array of object
The buttons attached to this block. Present when the block carries buttons.
Show child attributes
data.components.buttons.type
string
required
The button's behavior type.
Possible values (may grow over time): url, otp
data.components.buttons.otp_type
string
How the recipient receives the one-time passcode. Present on authentication-template OTP buttons.
Possible values (may grow over time): copy_code
data.components.buttons.text
string
required
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.
Show child attributes
data.components.buttons.example_parameters.type
object
required
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.
data.components.buttons.example_parameters.name
string
The named placeholder this example fills, for templates that use named parameters. Absent for system templates, which use positional parameters.