Skip to main content
PUT
Edit template

Overview

Updates an existing template and resubmits it for Meta approval. The body is the same used when creating the template.
When updating an approved template, it goes back to PENDING status until Meta reviews it again.
The templateId is obtained from the List templates endpoint.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

wabaId
string
required

WABA ID (obtained via List WABAs)

Example:

"428083093730937"

templateId
string
required

Template ID (obtained via List templates)

Example:

"1900296177408890"

Body

application/json
name
string
required

Template name: lowercase letters, digits and underscore. It cannot be changed after creation.

Maximum string length: 512
Pattern: ^[a-z0-9_]+$
category
enum<string>
required

Several types have a fixed category. See "Template types".

Available options:
UTILITY,
MARKETING,
AUTHENTICATION
language
string
required

Language in Meta's format, such as pt_BR or en_US.

parameter_format
enum<string>

Variable syntax. Named is Meta's current format.

Available options:
NAMED,
POSITIONAL
message_send_ttl_seconds
integer

Delivery window in seconds. Range by category: authentication 30 to 900, marketing 43200 to 2592000, utility 30 to 43200. The value -1 is a shortcut for 30 days.

allow_category_change
boolean

Lets Meta recategorize the template during review.

library_template_name
string

Model name in Meta's template library. See "Template Library".

library_template_body_inputs
object[]

Body options the library model accepts.

library_template_button_inputs
object[]

Button data for the library model.

components
object[]

Each item is a component, identified by the type field. The fields below belong to a specific type, and what each template type accepts is in "Template types".

Response

Template edited successfully

success
boolean

Indicates whether the operation was successful