List templates

get https://wabapi.yoni-tech.com/v2/whatsapp/templates

Returns a paginated list of WhatsApp templates you've previously created.

Response

Response body

object

items

array of objects

An array containing WhatsApp template objects.

items

object

wabaId

string

required

WhatsApp Business Account ID.

name

string

required

length ≤ 512

Name of the template.

language

string

required

Language code of the template. See Supported Languages for all codes.

category

string

enum

Category of WhatsApp templates.

AUTHENTICATION: Enable businesses to authenticate users with one-time passcodes, potentially at multiple steps in the login process (e.g., account verification, account recovery, integrity challenges).
MARKETING: Include promotions or offers, informational updates, or invitations for customers to respond / take action. Any conversation that does not qualify as utility or authentication is a marketing conversation.
UTILITY: Facilitate a specific, agreed-upon request or transaction or update to a customer about an ongoing transaction, including post-purchase notifications and recurring billing statements.

AUTHENTICATION MARKETING UTILITY

Allowed:

previousCategory

string

This field indicates the template's previous category (or null, for newly created templates after April 1, 2023). Compare this value to the template's category field value, which indicates the template's current category.
For more information about template category migration, see also First template category migration.

messageSendTtlSeconds

int32

Use only for template category is AUTHENTICATION.
If we are unable to deliver an authentication template for an amount of time that exceeds its time-to-live, we will stop retrying and drop the message.
Defaults to 600 seconds for newly created authentication templates.
To override the default value, set this field to a value between 60 and 600 seconds. Or set it to -1 resulting in a 30-day time-to-live.
We encourage you to set a time-to-live for all of your authentication templates, preferably equal to or less than your code expiration time, to ensure your customers only get a message when a code is still usable.

components

array of objects

length ≥ 1

Template components. A template consists of HEADER, BODY, FOOTER, and BUTTONS components. BODY component is required, the other types are optional.

components

object

type

string

enum

Required. Template component type.

BODY: Body components are text-only components and are required by all templates. Templates are limited to one body component.
HEADER: Headers are optional components that appear at the top of template messages. Headers support text, media (images, videos, documents). Templates are limited to one header component.
FOOTER: Footers are optional text-only components that appear immediately after the body component. Templates are limited to one footer component.
BUTTONS: Buttons are optional interactive components that perform specific actions when tapped.
LIMITED_TIME_OFFER: Use for limited-time offer templates. The delivered message can display an offer expiration details section with a heading, an optional expiration timer, and the offer code itself.
CAROUSEL: Carousel templates allow you to send a single text message (1), accompanied by a set of up to 10 carousel cards (2) in a horizontally scrollable view.

BODY HEADER FOOTER BUTTONS LIMITED_TIME_OFFER CAROUSEL

Allowed:

format

string

enum

Required for type HEADER.

TEXT IMAGE VIDEO DOCUMENT

Allowed:

text

string

length ≤ 1024

For body text (type = BODY), maximum 1024 characters.
For header text (type = HEADER, format = TEXT), maximum 60 characters.
For footer text (type = FOOTER), maximum 60 characters.
For card body text (CAROUSEL card component type = BODY), maximum 160 characters.

buttons

array of objects

length ≤ 10

Required for type BUTTONS.
Buttons are optional interactive components that perform specific actions when tapped. Templates can have a mixture of up to 10 button components total, although there are limits to individual buttons of the same type as well as combination limits.
If a template has more than three buttons, two buttons will appear in the delivered message and the remaining buttons will be replaced with a See all options button. Tapping the See all options button reveals the remaining buttons.

buttons

object

type

string

enum

required

Button type.

PHONE_NUMBER: Phone number buttons call the specified business phone number when tapped by the app user. Templates are limited to one phone number button.
URL: URL buttons load the specified URL in the device's default web browser when tapped by the app user. Templates are limited to two URL buttons.
QUICK_REPLY: Quick reply buttons are custom text-only buttons that immediately message you with the specified text string when tapped by the app user. Templates are limited to 10 quick reply buttons. If using quick reply buttons with other buttons, buttons must be organized into two groups: quick reply buttons and non-quick reply buttons.
COPY_CODE: Copy code buttons copy a text string (defined when the template is sent in a template message) to the device's clipboard when tapped by the app user. Templates are limited to one copy code button.
OTP: One-time password (OTP) buttons are a special type of URL button component used with authentication templates.
CATALOG: When a customer taps the View catalog button in a catalog template message, your product catalog appears within WhatsApp.
MPM: Customers can browse products and sections by tapping the View items button in a multi-product template message.

PHONE_NUMBER URL QUICK_REPLY COPY_CODE OTP CATALOG MPM

Allowed:

text

string

length ≤ 25

Required for button type PHONE_NUMBER or URL. Button text.
For CODE_CODE buttons, the text is a pre-set value and cannot be customized.
For OTP buttons, if omitted, the text will default to a pre-set value localized to the template's language. For example, Copy Code for English (US). If your template is using a one-tap autofill button and you supply this value, the authentication template message will display a copy code button with this text if we are unable to validate your handshake. Maximum 25 characters.

url

string

length ≤ 2000

Required for button type URL. URL of website.
There can be at most 1 variable at the end of the URL. Example: https://www.luckyshrub.com/shop?promo={{1}}.
2000 characters maximum.

phone_number

string

length ≤ 20

Required for button type PHONE_NUMBER.
Alphanumeric string. Business phone number to be (display phone number) called when the user taps the button.
20 characters maximum.

otp_type

string

enum

Indicates button OTP type.
Set to COPY_CODE if you want the template to use a copy code button, ONE_TAP to have it use a one-tap autofill button, or ZERO_TAP to have no button at all.

COPY_CODE ONE_TAP ZERO_TAP

Allowed:

autofill_text

string

length ≤ 25

One-tap and zero-tap buttons only.
One-tap button text.
Maximum 25 characters.

package_name

string

One-tap and zero-tap buttons only.
Your Android app's package name.

signature_hash

string

One-tap and zero-tap buttons only.
Your app signing key hash. See App Signing Key Hash.

zero_tap_terms_accepted

boolean

Zero-tap buttons only.
Set to true to indicate that you understand that your use of zero-tap authentication is subject to the WhatsApp Business Terms of Service, and that it's your responsibility to ensure your customers expect that the code will be automatically filled in on their behalf when they choose to receive the zero-tap code through WhatsApp.
If set to false, the template will not be created as you need to accept zero-tap terms before creating zero-tap enabled message templates.

example

array of strings

Sample full URL for a URL button with a variable.

example

add_security_recommendation

boolean

Optional. Only applicable in the BODY component of an AUTHENTICATION template.
Set to true if you want the template to include the string, For your security, do not share this code. Set to false to exclude the string.

code_expiration_minutes

int32

1 to 90

Optional. Only applicable in the FOOTER component of an AUTHENTICATION template.
Indicates number of minutes the password or code is valid.
If omitted, the code expiration warning will not be displayed in the delivered message.
Minimum 1, maximum 90.

limited_time_offer

object

Use for LIMITED_TIME_OFFER components.

example

object

Required when:

type is HEADER, and format is one of IMAGE, VIDEO, or DOCUMENT. Provide a sample media URL in header_url.
type is HEADER, format is TEXT, and a variable is used in text. Provide a sample value for that variable in header_text. There can be at most 1 variable in HEADER text.
type is BODY, and variables are used in text. Provide sample values for those variables in body_text.

cards

array of objects

length ≤ 10

Required for type CAROUSEL.
Carousel templates support up to 10 carousel cards.

cards

object

components

array of objects

Required.
Card components.

components

object

type

string

enum

Required.
Card component type.

BODY: Body components are text-only components. Cards must have body text.
HEADER: Cards must have a media header (image or video).
BUTTONS: Buttons are interactive components that perform specific actions when tapped. Cards must have at least one button, up to 2 buttons.

BODY HEADER BUTTONS

Allowed:

format

string

enum

Required for type HEADER.
Cards must have a media header (image or video).

IMAGE VIDEO

Allowed:

text

string

length ≤ 160

Required for type BODY.
Card body text supports variables. Maximum 160 characters.

buttons

array of objects

length between 1 and 2

Required for type BUTTONS.
Cards must have at least one button. Supports 2 buttons. Buttons can be the same or a mix of quick reply buttons, phone number buttons, or URL buttons.

buttons

object

type

string

enum

required

Button type.

PHONE_NUMBER: Phone number buttons call the specified business phone number when tapped by the app user. Templates are limited to one phone number button.
URL: URL buttons load the specified URL in the device's default web browser when tapped by the app user. Templates are limited to two URL buttons.
QUICK_REPLY: Quick reply buttons are custom text-only buttons that immediately message you with the specified text string when tapped by the app user. Templates are limited to 10 quick reply buttons. If using quick reply buttons with other buttons, buttons must be organized into two groups: quick reply buttons and non-quick reply buttons.
COPY_CODE: Copy code buttons copy a text string (defined when the template is sent in a template message) to the device's clipboard when tapped by the app user. Templates are limited to one copy code button.
OTP: One-time password (OTP) buttons are a special type of URL button component used with authentication templates.
CATALOG: When a customer taps the View catalog button in a catalog template message, your product catalog appears within WhatsApp.
MPM: Customers can browse products and sections by tapping the View items button in a multi-product template message.

PHONE_NUMBER URL QUICK_REPLY COPY_CODE OTP CATALOG MPM

Allowed:

text

string

length ≤ 25

url

string

length ≤ 2000

Required for button type URL. URL of website.
There can be at most 1 variable at the end of the URL. Example: https://www.luckyshrub.com/shop?promo={{1}}.
2000 characters maximum.

phone_number

string

length ≤ 20

Required for button type PHONE_NUMBER.
Alphanumeric string. Business phone number to be (display phone number) called when the user taps the button.
20 characters maximum.

otp_type

string

enum

Indicates button OTP type.
Set to COPY_CODE if you want the template to use a copy code button, ONE_TAP to have it use a one-tap autofill button, or ZERO_TAP to have no button at all.

COPY_CODE ONE_TAP ZERO_TAP

Allowed:

autofill_text

string

length ≤ 25

One-tap and zero-tap buttons only.
One-tap button text.
Maximum 25 characters.

package_name

string

One-tap and zero-tap buttons only.
Your Android app's package name.

signature_hash

string

One-tap and zero-tap buttons only.
Your app signing key hash. See App Signing Key Hash.

zero_tap_terms_accepted

boolean

example

array of strings

Sample full URL for a URL button with a variable.

example

object

Required when:

type is HEADER, and format is one of IMAGE, VIDEO, or DOCUMENT. Provide a sample media URL in header_url.
type is HEADER, format is TEXT, and a variable is used in text. Provide a sample value for that variable in header_text. There can be at most 1 variable in HEADER text.
type is BODY, and variables are used in text. Provide sample values for those variables in body_text.

status

string

enum

The status of a WhatsApp template.

PENDING: The template is still under review. Review can take up to 24 hours.
REJECTED: The template has been rejected during review process.
APPROVED: The template is approved, and you may begin sending it to customers.
PAUSED: The template has been paused due to recurring negative feedback from customers. Message templates with this status cannot be sent to customers. See Template Pausing.
DISABLED: The template has been disabled due to recurring negative feedback from customers or for violating one or more of our policies. Message templates with this status cannot be sent to customers. You may be able to edit a disabled message template and request an appeal. See Appeals.
IN_APPEAL: The template is in appeal. See also Template Appeals.
DELETED: The template is deleted.

PENDING REJECTED APPROVED PAUSED DISABLED IN_APPEAL DELETED

Allowed:

qualityRating

string

enum

Quality rating of WhatsApp template. One of GREEN, YELLOW, RED, or UNKNOWN. See also Template Quality Rating.

GREEN: High quality.
YELLOW: Medium quality.
RED: Low quality.
UNKNOWN: Unknown quality.

GREEN YELLOW RED UNKNOWN

Allowed:

reason

string

The reason why the template is rejected.

createTime

date-time

The time at which this object is created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

updateTime

date-time

The time at which this object is updated, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

statusUpdateEvent

string

enum

Used when an event happened on WhatsApp template status updates.

PENDING: Pending.
APPROVED: Approved.
REJECTED: Rejected.
IN_APPEAL: In appeal. See also Template Appeals.
PAUSED: Paused. See also Template Pausing.
FLAGGED: Flagged. The template is scheduled for disabling.
DISABLED: Disabled. See also Template Pausing.
REINSTATED: Reinstated.
PENDING_DELETION: Pending deletion.

PENDING APPROVED REJECTED IN_APPEAL PAUSED FLAGGED DISABLED REINSTATED PENDING_DELETION

disableDate

string

The date at which the template will be disabled. When a WhatsApp template FLAGGED event is received, this field is set.

whatsappApiError

object

The original error object returned by WhatsApp. See Handling Errors, Cloud API Error Codes.

offset

int32

required

≥ 0

The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.

limit

int32

required

≥ 1

A limit on the number of items to be returned, between 1 and 100, defaults to 10.

length

int32

required

≥ 0

The actual number of items in the page.

total

int32

≥ 0

The total number of items. This field is returned only when the request parameter includeTotal is set to true.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://wabapi.yoni-tech.com/v2/whatsapp/templates?page=1&limit=10&includeTotal=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved a paginated list of objects.