Enums

Enumerations used by the Template endpoints. Endpoints link here instead of repeating the full value lists.

Template Category

The category of a WhatsApp message template; determines the component rules. Used by: Create Template, Get Templates, Get Template Detail, and Update Template.

Value	Meaning
`UTILITY`	Transactional / utility messages (e.g. order updates).
`MARKETING`	Promotional messages (e.g. offers, announcements).
`AUTHENTICATION`	One-time passcodes and authentication messages.

Template Status

The review/lifecycle status of a template. Used by: Get Templates, Get Template Detail, Create Template, and Update Template.

Value	Meaning
`APPROVED`	Approved by Meta and usable.
`PENDING`	Under review (typical right after create/edit).
`REJECTED`	Rejected by Meta.
`PAUSED`	Paused, usually due to quality.
`DISABLED`	Disabled.
`IN_APPEAL`	Rejected and currently under appeal.
`PENDING_DELETION`	Deletion requested; Meta has not finalised it yet.
`DELETED`	Deleted on Meta. See Delete Template.
`LIMIT_EXCEEDED`	Blocked because the account’s template limit is exceeded.
`UNKNOWN`	Meta reported a status this API does not recognise.

Template Component Type

The type of an entry in a response components array. Used by: Get Templates, Get Template Detail, and Update Template — all with expand=components.

Value	Carries
`HEADER`	`format`, `text`, `example`.
`BODY`	`text`, `example`, `addSecurityRecommendation`.
`FOOTER`	`text`, `codeExpirationMinutes`.
`BUTTONS`	`buttons`.
`CAROUSEL`	`cards`.
`LIMITED_TIME_OFFER`	`limitedTimeOffer` (`text`, `hasExpiration`).

Card Component Type

The type of a component inside a carousel card (components[].cards[].components[]). A card is a reduced template: it has no footer and no limited-time offer. Used by: Get Template Detail.

Value	Carries
`HEADER`	`format` (`IMAGE` or `VIDEO`), `example`.
`BODY`	`text`, `example`.
`BUTTONS`	`buttons`.

Header Format

The format of a template header (header.format), and of each carousel card header. Used by: Create Template and Update Template.

Value	Meaning
`NONE`	No header (the default when `header` is omitted).
`TEXT`	Text header, max 60 chars; cannot start or end with a variable.
`IMAGE`	Image header; `examples` carries the media handle from Upload Media.
`VIDEO`	Video header; `examples` carries the media handle.
`DOCUMENT`	Document header; `examples` carries the media handle.
`LOCATION`	Location header; takes neither `text` nor `examples`.

Requests and responses differ slightly. On the way in, NONE is valid and is the default. On the way out, a HEADER component never reports NONE (the component is simply absent) but may report CAROUSEL for a carousel template’s header component.

Not every format is valid everywhere: AUTHENTICATION allows no header at all, a carousel card header must be IMAGE or VIDEO, and a limited-time offer header is limited to NONE / IMAGE / VIDEO.

Button Type

The type of a template button (buttons[].type). Used by: Create Template and Update Template.

Value	Required fields	Meaning
`QUICK_REPLY`	`text`	Sends a predefined reply back to you. Cannot carry `url` or `phoneNumber`.
`URL`	`text`, `url`	Opens a link. `url` must start with `https://` and may end in a `{{1}}` variable, in which case `example` is required.
`PHONE_NUMBER`	`text`, `phoneNumber`	Starts a call. `phoneNumber` is E.164 on the way in; Meta returns it in RFC3966 form (`tel:+90-555-...`).
`COPY_CODE`	`example`	Copies a coupon code to the clipboard. `MARKETING` only; `example` carries the code.
`OTP`	`otpType`	`AUTHENTICATION` only. See OTP Type.

Category and component rules narrow this list: AUTHENTICATION accepts only OTP, UTILITY accepts no OTP and no COPY_CODE, a carousel card accepts only QUICK_REPLY / URL / PHONE_NUMBER, and a limited-time offer accepts only COPY_CODE / URL.

OTP Type

The sub-type of an OTP button (buttons[].otpType), used by AUTHENTICATION templates. Used by: Create Template and Update Template.

Value	Also requires	Meaning
`COPY_CODE`	—	The user copies the code manually.
`ONE_TAP`	`packageName`, `signatureHash`	The app reads the code with one tap. `autofillText` is optional.
`ZERO_TAP`	`packageName`, `signatureHash`, `zeroTapTermsAccepted: true`	The code is delivered to the app without any user action.

Template Expand

Optional expansions requested through the repeatable expand query parameter. Used by: Get Templates and Get Template Detail.

Value	Meaning
`components`	Also return the template’s `components` (header / body / footer / buttons). Omitted by default.

Any other value is rejected with 422.

Template Language

The language code a template is created in (language). This is a closed list — a code outside it is rejected with 422, so it is not free-form BCP-47. Used by: Create Template.

The language query filter on Get Templates is a plain string and is passed to Meta as-is, so it is not restricted to this list.

Language	Codes
Afrikaans	`af`
Albanian	`sq`
Arabic	`ar`, `ar_EG`, `ar_AE`, `ar_LB`, `ar_MA`, `ar_QA`
Azerbaijani	`az`
Belarusian	`be_BY`
Bengali	`bn`, `bn_IN`
Bulgarian	`bg`
Catalan	`ca`
Chinese	`zh_CN`, `zh_HK`, `zh_TW`
Croatian	`hr`
Czech	`cs`
Danish	`da`
Dari	`prs_AF`
Dutch	`nl`, `nl_BE`
English	`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`
Estonian	`et`
Filipino	`fil`
Finnish	`fi`
French	`fr`, `fr_BE`, `fr_CA`, `fr_CH`, `fr_CI`, `fr_MA`
Georgian	`ka`
German	`de`, `de_AT`, `de_CH`
Greek	`el`
Gujarati	`gu`
Hausa	`ha`
Hebrew	`he`
Hindi	`hi`
Hungarian	`hu`
Indonesian	`id`
Irish	`ga`
Italian	`it`
Japanese	`ja`
Kannada	`kn`
Kazakh	`kk`
Kinyarwanda	`rw_RW`
Korean	`ko`
Kyrgyz	`ky_KG`
Lao	`lo`
Latvian	`lv`
Lithuanian	`lt`
Macedonian	`mk`
Malay	`ms`
Malayalam	`ml`
Marathi	`mr`
Norwegian	`nb`
Pashto	`ps_AF`
Persian	`fa`
Polish	`pl`
Portuguese	`pt_BR`, `pt_PT`
Punjabi	`pa`
Romanian	`ro`
Russian	`ru`
Serbian	`sr`
Sinhala	`si_LK`
Slovak	`sk`
Slovenian	`sl`
Spanish	`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`
Swahili	`sw`
Swedish	`sv`
Tamil	`ta`
Telugu	`te`
Thai	`th`
Turkish	`tr`
Ukrainian	`uk`
Urdu	`ur`
Uzbek	`uz`
Vietnamese	`vi`
Zulu	`zu`

Template Quality Score

The quality rating of a template, derived by Meta from user feedback. Used by: Get Templates and Get Template Detail.

Value	Meaning
`GREEN`	High quality.
`YELLOW`	Medium quality.
`RED`	Low quality.
`UNKNOWN`	Not yet rated / unknown.

Template Parameter Format

How variables are referenced within a template. Used by: Get Templates and Get Template Detail.

Value	Meaning
`POSITIONAL`	Variables referenced by position (`{{1}}`, `{{2}}`).
`NAMED`	Variables referenced by name.
`UNKNOWN`	Meta reported a format this API does not recognise.

Template Rejected Reason

Why Meta rejected a template. Used by: Get Templates and Get Template Detail (rejectedReason).

Value	Meaning
`NONE`	Not rejected.
`ABUSIVE_CONTENT`	Content violates Meta’s abuse policies.
`INVALID_FORMAT`	The template structure or formatting is invalid.
`PROMOTIONAL`	Promotional content submitted under a non-marketing category.
`TAG_CONTENT_MISMATCH`	The content does not match the declared category.
`SCAM`	Flagged as a scam.
`INCORRECT_CATEGORY`	Submitted under the wrong category.
`UNKNOWN`	Meta reported a reason this API does not recognise.

Template Metrics Granularity

The time-bucket period for template analytics. Used by: Get Template Metrics (granularity query parameter; default DAILY).

Value	Meaning
`DAILY`	Bucketed by day. The only granularity Meta exposes for template analytics.

Template Metrics Metric Type

Which metrics Meta should return. Repeatable via the metricType query parameter; omit it to get the core set. Anything outside the core set is surfaced per bucket under additionalMetrics. Used by: Get Template Metrics.

Value	Set	Meaning
`SENT`	core	Messages sent.
`DELIVERED`	core	Messages delivered.
`READ`	core	Messages read.
`CLICKED`	core	Button clicks.
`COST`	core	Spend, returned as the cost breakdown.
`APP_ACTIVATIONS`	conversion	In-app activations attributed to the template.
`APP_ADD_TO_CART`	conversion	In-app add-to-cart events.
`APP_CHECKOUTS_INITIATED`	conversion	In-app checkouts started.
`APP_PURCHASES`	conversion	In-app purchases.
`APP_PURCHASES_CONVERSION_VALUE`	conversion	Monetary value of in-app purchases.
`WEBSITE_ADD_TO_CART`	conversion	Website add-to-cart events.
`WEBSITE_CHECKOUTS_INITIATED`	conversion	Website checkouts started.
`WEBSITE_PURCHASES`	conversion	Website purchases.
`WEBSITE_PURCHASES_CONVERSION_VALUE`	conversion	Monetary value of website purchases.

Template Metrics Product Type

The messaging product the metrics are scoped to. Used by: Get Template Metrics (productType query parameter; omit for all products).

Value	Meaning
`CLOUD_API`	Templates sent through the WhatsApp Cloud API.
`MARKETING_MESSAGES_LITE_API`	Templates sent through the Marketing Messages Lite API.

Template Metrics Click Type

How a button click was recorded. Appears as type inside clicksBreakdown. Used by: Get Template Metrics.

Value	Counted in `clicked`	Meaning
`url_button`	yes	Clicks on a URL button.
`quick_reply_button`	yes	Taps on a quick-reply button.
`unique_url_button`	no	Unique (de-duplicated) URL button clicks. Reported in the breakdown but excluded from the `clicked` total so clicks are not counted twice.

Template Metrics Cost Type

The kind of cost line reported. Appears as type inside costBreakdown. Used by: Get Template Metrics.

Value	Meaning
`amount_spent`	Total spend for the bucket or the range.
`cost_per_delivered`	Spend divided by delivered messages.
`cost_per_url_button_click`	Spend divided by URL button clicks, when Meta reports it.

Getting Started

Analytics

Application

Template

Media

Developers

Reference

Template Category

Template Status

Template Component Type

Card Component Type

Header Format

Button Type

OTP Type

Template Expand

Template Language

Template Quality Score

Template Parameter Format

Template Rejected Reason

Template Metrics Granularity

Template Metrics Metric Type

Template Metrics Product Type

Template Metrics Click Type

Template Metrics Cost Type

​Template Category

​Template Status

​Template Component Type

​Card Component Type

​Header Format

​Button Type

​OTP Type

​Template Expand

​Template Language

​Template Quality Score

​Template Parameter Format

​Template Rejected Reason

​Template Metrics Granularity

​Template Metrics Metric Type

​Template Metrics Product Type

​Template Metrics Click Type

​Template Metrics Cost Type

Template Category

Template Status

Template Component Type

Card Component Type

Header Format

Button Type

OTP Type

Template Expand

Template Language

Template Quality Score

Template Parameter Format

Template Rejected Reason

Template Metrics Granularity

Template Metrics Metric Type

Template Metrics Product Type

Template Metrics Click Type

Template Metrics Cost Type