Skip to main content
GET
Retrieve a template

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Path Parameters

template_id
string
required

Unique identifier for a template.

Pattern: ^tpl_[0-9a-f]{32}$
Example:

"tpl_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

A WhatsApp message template, as registered on one channel.

channel_id
string
required

The channel this template is registered on.

Pattern: ^chn_[0-9a-f]{32}$
Example:

"chn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

created_at
string<date-time>
required
id
string
required

Unique identifier for a template.

Pattern: ^tpl_[0-9a-f]{32}$
Example:

"tpl_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

language
string
required

Language code, e.g. pt_BR or en_US.

name
string
required
status
enum<string>
required

Where a template stands with WhatsApp on its channel.

Only approved templates can be sent. pending is awaiting review (or still being submitted). rejected was refused, or could not be submitted. paused was approved but is suspended, usually for low quality.

Available options:
approved,
pending,
rejected,
paused
updated_at
string<date-time>
required
body
string | null

The message text, with its placeholders as written: {{1}} for numbered variables or {{name}} for named ones.

buttons
TemplateButton · object[]
category
enum<string> | null

Null when WhatsApp reports a category not listed.

Available options:
marketing,
utility,
authentication
header
TemplateHeader · object | null

The line or attachment shown above the body.

object
string
default:template
Allowed value: "template"