{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"wabaId": "whatsapp-business-account-id",
"name": "<string>",
"language": "en",
"officialTemplateId": "official-template-id",
"category": "AUTHENTICATION",
"subCategory": "ORDER_STATUS",
"previousCategory": "<string>",
"messageSendTtlSeconds": 600,
"components": [
{
"type": "BODY",
"format": "TEXT",
"text": "<string>",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "<string>",
"url": "<string>",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"supported_apps": [
{
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7"
}
],
"zero_tap_terms_accepted": true,
"example": [
"<string>"
],
"flow_id": "1",
"flow_name": "<string>",
"flow_json": "<string>",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN",
"app_deep_link": {
"meta_app_id": "2892949377516980",
"android_deep_link": "luckyshrub://deals/summer/",
"android_fallback_playstore_url": "https://www.luckyshrub.com/deals/summer/"
}
}
],
"add_security_recommendation": true,
"code_expiration_minutes": 5,
"limited_time_offer": {
"text": "Expiring offer!",
"has_expiration": true
},
"example": {
"body_text": [
[
"<string>"
]
],
"header_text": [
"<string>"
],
"header_url": [
"<string>"
]
},
"cards": [
{
"components": [
{
"type": "BODY",
"format": "IMAGE",
"text": "<string>",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "<string>",
"url": "<string>",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"supported_apps": [
{
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7"
}
],
"zero_tap_terms_accepted": true,
"example": [
"<string>"
],
"flow_id": "1",
"flow_name": "<string>",
"flow_json": "<string>",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN",
"app_deep_link": {
"meta_app_id": "2892949377516980",
"android_deep_link": "luckyshrub://deals/summer/",
"android_fallback_playstore_url": "https://www.luckyshrub.com/deals/summer/"
}
}
],
"example": {
"body_text": [
[
"<string>"
]
],
"header_text": [
"<string>"
],
"header_url": [
"<string>"
]
}
}
]
}
]
}
],
"ctaUrlLinkTrackingOptedOut": true,
"status": "REJECTED",
"qualityRating": "GREEN",
"reason": "<string>",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z",
"statusUpdateEvent": "PENDING",
"disableDate": "December 9, 2022",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
}
}
]
}List templates
Returns a paginated list of WhatsApp templates you’ve previously created.
Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.
{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"wabaId": "whatsapp-business-account-id",
"name": "<string>",
"language": "en",
"officialTemplateId": "official-template-id",
"category": "AUTHENTICATION",
"subCategory": "ORDER_STATUS",
"previousCategory": "<string>",
"messageSendTtlSeconds": 600,
"components": [
{
"type": "BODY",
"format": "TEXT",
"text": "<string>",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "<string>",
"url": "<string>",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"supported_apps": [
{
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7"
}
],
"zero_tap_terms_accepted": true,
"example": [
"<string>"
],
"flow_id": "1",
"flow_name": "<string>",
"flow_json": "<string>",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN",
"app_deep_link": {
"meta_app_id": "2892949377516980",
"android_deep_link": "luckyshrub://deals/summer/",
"android_fallback_playstore_url": "https://www.luckyshrub.com/deals/summer/"
}
}
],
"add_security_recommendation": true,
"code_expiration_minutes": 5,
"limited_time_offer": {
"text": "Expiring offer!",
"has_expiration": true
},
"example": {
"body_text": [
[
"<string>"
]
],
"header_text": [
"<string>"
],
"header_url": [
"<string>"
]
},
"cards": [
{
"components": [
{
"type": "BODY",
"format": "IMAGE",
"text": "<string>",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "<string>",
"url": "<string>",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"supported_apps": [
{
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7"
}
],
"zero_tap_terms_accepted": true,
"example": [
"<string>"
],
"flow_id": "1",
"flow_name": "<string>",
"flow_json": "<string>",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN",
"app_deep_link": {
"meta_app_id": "2892949377516980",
"android_deep_link": "luckyshrub://deals/summer/",
"android_fallback_playstore_url": "https://www.luckyshrub.com/deals/summer/"
}
}
],
"example": {
"body_text": [
[
"<string>"
]
],
"header_text": [
"<string>"
],
"header_url": [
"<string>"
]
}
}
]
}
]
}
],
"ctaUrlLinkTrackingOptedOut": true,
"status": "REJECTED",
"qualityRating": "GREEN",
"reason": "<string>",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z",
"statusUpdateEvent": "PENDING",
"disableDate": "December 9, 2022",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
}
}
]
}Authorizations
Query Parameters
Page number of the results to be returned, 1-based.
1 <= x <= 100A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.
1 <= x <= 100Return results inside an object that contains the total result count or not.
Required if you have more than 100 WABAs. WhatsApp Business Account ID.
"whatsapp-business-account-id"
Name of the template.
512[a-z0-9]{1,512}"sample_whatsapp_template"
Language code of the template. See Supported Languages for all codes.
"en"
Comma-separated template statuses to filter by. Supported values include PENDING, REJECTED, APPROVED, PAUSED, DISABLED, ARCHIVED, IN_APPEAL, and DELETED.
"APPROVED,ARCHIVED"
Response
Successfully retrieved a paginated list of objects.
Represents a given page of WhatsApp templates.
The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.
x >= 0A limit on the number of items to be returned, between 1 and 100, defaults to 10.
x >= 1The actual number of items in the page.
x >= 0The total number of items. This field is returned only when the request parameter includeTotal is set to true.
x >= 0An array containing WhatsApp template objects.
Show child attributes
Show child attributes

