Edit WhatsApp Template

Edit a WhatsApp template. Edited template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to template guidelines for additional info.

Only templates with an approved, rejected or paused status can be edited.
Please use structure documented in Create WhatsApp Template endpoint.
Category of an approved template cannot be edited.
Approved template can be edited up to 10 times in a 30 day window, or 1 time in a 24 hour window. Rejected or paused templates can be edited an unlimited number of times.

Learn more about WhatsApp channel and use cases.

Please log in to see full path URL. Learn why.

patch

/whatsapp/2/senders/{sender}/templates/{id}

Authorizations:

Scopes:

whatsapp:manage

Request rate limit:

100 requests / hour (per account)

Learn more

path Parameters

sender required	string Example: 447796344125 Registered WhatsApp sender number. Must be in international format.
id required	string Example: 5653923468715475 Template ID. Must be a number.

Request Body schema:

application/json

collapse all -

category

string

Enum: "MARKETING" "AUTHENTICATION" "UTILITY"

Category of the template. Approved template category cannot be edited.

structure

object

Template structure. Format depends on the template category.

validityPeriod

object

Template validity period in which WhatsApp will try to deliver template message to end user. Validity period can be customized between 1 and 10 minutes. -1 can be used to use Meta's default message validity period. This is 24 hours for the Cloud senders and 30 days for the On-Premises. Works only for templates with AUTHENTICATION category. It can be only edited alongside with category or structure in the request.

amount required	integer <int32> Template validity period amount.
timeUnit	string Default: "MINUTES" Enum: "SECONDS" "MINUTES" Message template validity period time unit.

platform

object

Platform options. For more details, see documentation.

entityId	string [ 0 .. 255 ] characters Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.
applicationId	string [ 0 .. 255 ] characters Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.

Responses

200

Template edited.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found.

429

Too Many Requests

500

Internal Server Error

Request samples

Content type

application/json

Example

Copy

Collapse all


{"category": "MARKETING",
"structure": 
{"body": 
{"text": "body {{1}} content",
"examples": 
["example"
]
},
"type": "TEXT"
}
}

Response samples

Content type

application/json

Example

Copy

Collapse all


{"id": "111",
"businessAccountId": 222,
"name": "media_template",
"language": "en",
"status": "APPROVED",
"category": "MARKETING",
"structure": 
{"header": 
{"format": "IMAGE"
},
"body": 
{"text": "example {{1}} body"
},
"footer": 
{"text": "exampleFooter"
},
"type": "MEDIA"
},
"quality": "HIGH",
"platform": 
{"entityId": "entityId",
"applicationId": "applicationId"
},
"createdAt": "2024-01-01T00:00:00.000+0000",
"lastUpdatedAt": "2024-01-01T00:00:00.000+0000"
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use