{
"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>"
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"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>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Edit a template
Edits a WhatsApp template by name and language. Editing a template replaces its old contents entirely, so include any components you wish to preserve as well as components you wish to update using the components parameter.
Only templates in APPROVED, REJECTED, or PAUSED status can be edited. ARCHIVED templates cannot be edited.
{
"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>"
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"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>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Name of the template.
[a-z0-9]{1,512}"sample_whatsapp_template"
Language code of the template. See Supported Languages for all codes.
"en"
Body
The request body to edit a WhatsApp template.
Show child attributes
Show child attributes
If we are unable to deliver a message for an amount of time that exceeds its time-to-live, we will stop retrying and drop the message.
By default, messages that use an authentication template have a default TTL of 10 minutes, and messages that use a utility or marketing template have a default TTL of 30 days.
Set its value between 30 and 900 seconds (i.e., 30 seconds to 15 minutes) for authentication templates, or 30 and 43200 seconds (i.e., 30 seconds to 12 hours) for utility templates, or 43200 and 2592000 seconds (i.e., 12 hours to 30 days) for marketing templates. Alternatively, you can set this value to -1, which will set a custom TTL of 30 days for either type of template.
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.
Authentication templates created before October 23, 2024, have a default TTL of 30 days.
600
Optional.
Indicates if template button click tracking is disabled. Set to true to disable button click tracking on the template, or false to enable.
You can disable button click tracking on an individual template by setting this field to true. Once disabled, button engagement/clicks will not be displayed in the WhatsApp Manager when viewing the template's insights.
If not provided or set to null, this value defaults to true, which means button click tracking is disabled by default.
true
Response
Successfully edited the template.
See WhatsApp Templates.
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Name of the template.
512[a-z0-9]{1,512}Language code of the template. See Supported Languages for all codes.
"en"
Official template ID assigned by WhatsApp. This ID is used to identify the template in WhatsApp's system.
"official-template-id"
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 Subcategory of WhatsApp templates.
- ORDER_STATUS: Order status template is categorized as
UTILITYtemplate and apart from name and language of choice, it has general template components such asBODY,FOOTERand additionally subcategory asORDER_STATUS.
ORDER_STATUS 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.
If we are unable to deliver a message for an amount of time that exceeds its time-to-live, we will stop retrying and drop the message.
By default, messages that use an authentication template have a default TTL of 10 minutes, and messages that use a utility or marketing template have a default TTL of 30 days.
Set its value between 30 and 900 seconds (i.e., 30 seconds to 15 minutes) for authentication templates, or 30 and 43200 seconds (i.e., 30 seconds to 12 hours) for utility templates, or 43200 and 2592000 seconds (i.e., 12 hours to 30 days) for marketing templates. Alternatively, you can set this value to -1, which will set a custom TTL of 30 days for either type of template.
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.
Authentication templates created before October 23, 2024, have a default TTL of 30 days.
600
Template components. A template consists of HEADER, BODY, FOOTER, and BUTTONS components. BODY component is required, the other types are optional.
1Show child attributes
Show child attributes
Whether Meta CTA URL click tracking is disabled. Historical null values are returned as true.
true
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.ARCHIVED: The template has been archived. Archived templates cannot be sent or edited.IN_APPEAL: The template is in appeal. See also Template Appeals.DELETED: The template is deleted.
PENDING, REJECTED, APPROVED, PAUSED, DISABLED, ARCHIVED, IN_APPEAL, DELETED "REJECTED"
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 The reason why the template is rejected.
The WhatsApp template status update event that caused this webhook. For ARCHIVED, the template status is ARCHIVED. For UNARCHIVED, the template status is the current status returned by Meta, for example APPROVED; it does not represent a new approval review.
PENDING, APPROVED, REJECTED, IN_APPEAL, PAUSED, FLAGGED, DISABLED, ARCHIVED, UNARCHIVED, REINSTATED, PENDING_DELETION The date at which the template will be disabled. When a WhatsApp template FLAGGED event is received, this field is set.
"December 9, 2022"
The original error object returned by WhatsApp. See Handling Errors, Cloud API Error Codes.
Show child attributes
Show child attributes