Pular para o conteúdo principal
PUT
Editar template

Conceituação

Atualiza um template existente e reenvia para aprovação da Meta. O body é o mesmo utilizado na criação do template.
Ao atualizar um template aprovado, ele volta para o status PENDING até ser revisado novamente pela Meta.
O templateId é obtido através do endpoint de Listar templates.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Parâmetros de caminho

wabaId
string
obrigatório

ID do WABA (obtido via Listar WABAs)

Exemplo:

"428083093730937"

templateId
string
obrigatório

ID do template (obtido via Listar templates)

Exemplo:

"1900296177408890"

Corpo

application/json
name
string
obrigatório

Nome do template: minúsculas, números e sublinhado. Não pode ser alterado depois de criado.

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

Vários tipos têm categoria fixa. Ver "Tipos de template".

Opções disponíveis:
UTILITY,
MARKETING,
AUTHENTICATION
language
string
obrigatório

Idioma no formato da Meta, como pt_BR ou en_US.

parameter_format
enum<string>

Sintaxe das variáveis. Nomeado é o formato atual da Meta.

Opções disponíveis:
NAMED,
POSITIONAL
message_send_ttl_seconds
integer

Validade do envio em segundos. Faixa por categoria: autenticação 30 a 900, marketing 43200 a 2592000, utility 30 a 43200. O valor -1 é atalho de 30 dias.

allow_category_change
boolean

Permite que a Meta recategorize o template na revisão.

library_template_name
string

Nome do modelo na biblioteca da Meta. Ver "Template Library".

library_template_body_inputs
object[]

Ajustes de corpo que o modelo da biblioteca aceita.

library_template_button_inputs
object[]

Dados dos botões do modelo da biblioteca.

components
object[]

Cada item é um componente, identificado pelo campo type. Os campos abaixo pertencem a um type específico, e o que cada tipo de template aceita está em "Tipos de template".

Resposta

Template editado com sucesso

success
boolean

Indica se a operação foi realizada com sucesso