Skip to main content
POST
Create WhatsApp Template

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

sender
string
required

Registered WhatsApp sender number. Must be in international format.

Body

application/json
name
string
required

Template name. Must only contain lowercase alphanumeric characters and underscores.

Minimum string length: 1
Pattern: ^[a-z0-9_]{1,512}$
language
enum<string>
required

Template language, one template with same name can have multiple transliterations.

Available options:
af,
sq,
ar,
ar_EG,
ar_AE,
ar_LB,
ar_MA,
ar_QA,
az,
bn,
bn_IN,
bg,
ca,
zh_CN,
zh_HK,
zh_TW,
hr,
cs,
da,
nl,
nl_BE,
en,
en_GB,
en_US,
en_AE,
en_AU,
en_CA,
en_GH,
en_IE,
en_IN,
en_JM,
en_MY,
en_NZ,
en_QA,
en_SG,
en_UG,
en_ZA,
et,
fil,
fi,
fr,
fr_BE,
fr_CA,
fr_CH,
fr_CI,
fr_MA,
ka,
de,
de_AT,
de_CH,
el,
gu,
ha,
he,
hi,
hu,
id,
ga,
it,
ja,
kn,
kk,
rw_RW,
ko,
ky_KG,
lo,
lv,
lt,
mk,
ms,
ml,
mr,
nb,
fa,
pl,
pt_BR,
pt_PT,
pa,
ro,
ru,
sr,
si_LK,
sk,
sl,
es,
es_AR,
es_CL,
es_CO,
es_CR,
es_DO,
es_EC,
es_HN,
es_MX,
es_PA,
es_PE,
es_ES,
es_UY,
sw,
sv,
ta,
te,
th,
tr,
uk,
ur,
uz,
vi,
zu,
unknown
Example:

"en"

category
enum<string>
required

All listed categories will be available until May 1, 2023.

Available options:
ACCOUNT_UPDATE,
PAYMENT_UPDATE,
PERSONAL_FINANCE_UPDATE,
SHIPPING_UPDATE,
RESERVATION_UPDATE,
ISSUE_RESOLUTION,
APPOINTMENT_UPDATE,
TRANSPORTATION_UPDATE,
TICKET_UPDATE,
ALERT_UPDATE,
AUTO_REPLY
Minimum string length: 1
Example:

"ACCOUNT_UPDATE"

structure
V1TemplateStructureApiData · object
required

Template structure.

Response

Template created.

List of all templates for given sender.

id
string

Template ID.

Example:

"111"

businessAccountId
integer<int64>

Business account ID to which template belongs.

Example:

222

name
string

Name of the template.

Example:

"template_name"

language
enum<string>

Template language, one template with same name can have multiple transliterations.

Available options:
af,
sq,
ar,
ar_EG,
ar_AE,
ar_LB,
ar_MA,
ar_QA,
az,
bn,
bn_IN,
bg,
ca,
zh_CN,
zh_HK,
zh_TW,
hr,
cs,
da,
nl,
nl_BE,
en,
en_GB,
en_US,
en_AE,
en_AU,
en_CA,
en_GH,
en_IE,
en_IN,
en_JM,
en_MY,
en_NZ,
en_QA,
en_SG,
en_UG,
en_ZA,
et,
fil,
fi,
fr,
fr_BE,
fr_CA,
fr_CH,
fr_CI,
fr_MA,
ka,
de,
de_AT,
de_CH,
el,
gu,
ha,
he,
hi,
hu,
id,
ga,
it,
ja,
kn,
kk,
rw_RW,
ko,
ky_KG,
lo,
lv,
lt,
mk,
ms,
ml,
mr,
nb,
fa,
pl,
pt_BR,
pt_PT,
pa,
ro,
ru,
sr,
si_LK,
sk,
sl,
es,
es_AR,
es_CL,
es_CO,
es_CR,
es_DO,
es_EC,
es_HN,
es_MX,
es_PA,
es_PE,
es_ES,
es_UY,
sw,
sv,
ta,
te,
th,
tr,
uk,
ur,
uz,
vi,
zu,
unknown
Example:

"en"

status
enum<string>

Status of the template.

Available options:
APPROVED,
IN_APPEAL,
PENDING,
REJECTED,
PENDING_DELETION,
DELETED,
REINSTATED,
FLAGGED,
FIRST_PAUSED,
SECOND_PAUSED,
DISABLED,
ARCHIVED,
UNKNOWN
Example:

"APPROVED"

category
enum<string>

Category of the template.

Available options:
ACCOUNT_UPDATE,
PAYMENT_UPDATE,
PERSONAL_FINANCE_UPDATE,
SHIPPING_UPDATE,
RESERVATION_UPDATE,
ISSUE_RESOLUTION,
APPOINTMENT_UPDATE,
TRANSPORTATION_UPDATE,
TICKET_UPDATE,
ALERT_UPDATE,
AUTO_REPLY,
TRANSACTIONAL,
OTP,
MARKETING,
AUTHENTICATION,
UTILITY
Example:

"ACCOUNT_UPDATE"

structure
V1TemplateStructureApiData · object

Template structure.