Skip to main content
POST
whatsapp.template.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by whatsapp.template.create or a row of whatsapp.templates.list-details.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

name
string
required

Template name, using lowercase letters, digits and underscores.

Required string length: 1 - 512
Pattern: ^[a-z0-9_]+$
language
string
required

Language code, such as en_US.

Required string length: 1 - 16
Pattern: ^[a-z]{2,3}(_[A-Za-z]{2,4})?$
status
enum<string>
required

Template approval state.

Available options:
approved,
pending,
rejected,
paused,
disabled
category
enum<string>
required

What the template is for.

Available options:
marketing,
utility,
authentication
type
enum<string>
required

Template layout. Some layouts require additional media or catalog support.

Available options:
text,
image,
video,
document,
location,
catalog,
product,
carousel,
limited_offer,
gif
body
string

Message body, including variable markers.

Required string length: 1 - 4096
header
string

Text header.

Required string length: 1 - 60

Footer.

Required string length: 1 - 60
buttons
object[]

Template buttons. Contact requests must be the only button.

Maximum array length: 10

A template button.

quality
enum<string>

Quality of this message template.

Available options:
high,
medium,
low,
unknown
rejectionReason
string

Neutral explanation of a rejected template.

Required string length: 1 - 256