Skip to main content
POST
Create a message template

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer cb_live_.... Create one in Settings → API Keys. See public_api.md § 3 for scopes.

Body

name
string
required
Required string length: 1 - 512
category
enum<string>
required
  • ACCOUNT_UPDATE - ACCOUNT_UPDATE
  • PAYMENT_UPDATE - PAYMENT_UPDATE
  • PERSONAL_FINANCE_UPDATE - PERSONAL_FINANCE_UPDATE
  • SHIPPING_UPDATE - SHIPPING_UPDATE
  • RESERVATION_UPDATE - RESERVATION_UPDATE
  • ISSUE_RESOLUTION - ISSUE_RESOLUTION
  • APPOINTMENT_UPDATE - APPOINTMENT_UPDATE
  • TRANSPORTATION_UPDATE - TRANSPORTATION_UPDATE
  • TICKET_UPDATE - TICKET_UPDATE
  • ALERT_UPDATE - ALERT_UPDATE
  • AUTO_REPLY - AUTO_REPLY
  • TRANSACTIONAL - TRANSACTIONAL
  • OTP - OTP
  • UTILITY - UTILITY
  • MARKETING - MARKETING
  • AUTHENTICATION - AUTHENTICATION
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,
UTILITY,
MARKETING,
AUTHENTICATION
components
object[]
required
allow_category_change
boolean
default:true
language
enum<string>
default:en_US
  • af - af
  • sq - sq
  • ar - ar
  • az - az
  • bn - bn
  • bg - bg
  • ca - ca
  • zh_CN - zh_CN
  • zh_HK - zh_HK
  • zh_TW - zh_TW
  • hr - hr
  • cs - cs
  • da - da
  • nl - nl
  • en - en
  • en_GB - en_GB
  • en_US - en_US
  • et - et
  • fil - fil
  • fi - fi
  • fr - fr
  • ka - ka
  • de - de
  • el - el
  • gu - gu
  • ha - ha
  • he - he
  • hi - hi
  • hu - hu
  • id - id
  • ga - ga
  • it - it
  • ja - ja
  • kn - kn
  • kk - kk
  • rw_RW - rw_RW
  • ko - ko
  • ky_KG - ky_KG
  • lo - lo
  • lv - lv
  • lt - lt
  • mk - mk
  • ms - ms
  • ml - ml
  • mr - mr
  • nb - nb
  • fa - fa
  • pl - pl
  • pt_BR - pt_BR
  • pt_PT - pt_PT
  • pa - pa
  • ro - ro
  • ru - ru
  • sr - sr
  • sk - sk
  • sl - sl
  • es - es
  • es_AR - es_AR
  • es_ES - es_ES
  • es_MX - es_MX
  • sw - sw
  • sv - sv
  • ta - ta
  • te - te
  • th - th
  • tr - tr
  • uk - uk
  • ur - ur
  • uz - uz
  • vi - vi
  • zu - zu
Available options:
af,
sq,
ar,
az,
bn,
bg,
ca,
zh_CN,
zh_HK,
zh_TW,
hr,
cs,
da,
nl,
en,
en_GB,
en_US,
et,
fil,
fi,
fr,
ka,
de,
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,
sk,
sl,
es,
es_AR,
es_ES,
es_MX,
sw,
sv,
ta,
te,
th,
tr,
uk,
ur,
uz,
vi,
zu
source_library_template_id
integer
write-only
whatsapp_business_account_id
integer

Provide the WhatsApp Business Account ID. If multiple accounts are present, provide the account ID otherwise it will be defaulted to the first account

Response

201 - application/json
business_account_id
string
required
whatsapp_account_id
string
required
template_id
string
required
Maximum string length: 255
name
string
required
Maximum string length: 512
components
any
required
language
string
required
Maximum string length: 8
status
enum<string>
required
  • APPROVED - APPROVED
  • IN_APPEAL - IN_APPEAL
  • PENDING - PENDING
  • REJECTED - REJECTED
  • PENDING_DELETION - PENDING_DELETION
  • DELETED - DELETED
  • DISABLED - DISABLED
  • PAUSED - PAUSED
  • LIMIT_EXCEEDED - LIMIT_EXCEEDED
  • ARCHIVED - ARCHIVED
Available options:
APPROVED,
IN_APPEAL,
PENDING,
REJECTED,
PENDING_DELETION,
DELETED,
DISABLED,
PAUSED,
LIMIT_EXCEEDED,
ARCHIVED
category
enum<string>
required
  • ACCOUNT_UPDATE - ACCOUNT_UPDATE
  • PAYMENT_UPDATE - PAYMENT_UPDATE
  • PERSONAL_FINANCE_UPDATE - PERSONAL_FINANCE_UPDATE
  • SHIPPING_UPDATE - SHIPPING_UPDATE
  • RESERVATION_UPDATE - RESERVATION_UPDATE
  • ISSUE_RESOLUTION - ISSUE_RESOLUTION
  • APPOINTMENT_UPDATE - APPOINTMENT_UPDATE
  • TRANSPORTATION_UPDATE - TRANSPORTATION_UPDATE
  • TICKET_UPDATE - TICKET_UPDATE
  • ALERT_UPDATE - ALERT_UPDATE
  • AUTO_REPLY - AUTO_REPLY
  • TRANSACTIONAL - TRANSACTIONAL
  • OTP - OTP
  • UTILITY - UTILITY
  • MARKETING - MARKETING
  • AUTHENTICATION - AUTHENTICATION
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,
UTILITY,
MARKETING,
AUTHENTICATION
business_account
integer
required
quality_score
enum<string>
  • GREEN - GREEN
  • YELLOW - YELLOW
  • RED - RED
  • UNKNOWN - UNKNOWN
  • BLANK - BLANK
Available options:
GREEN,
YELLOW,
RED,
UNKNOWN,
BLANK
source_library_template
integer | null