Criar template

Crie um novo template e envie para aprovação da Meta

POST /whatsapp/businesses/{wabaId}/templates

cURL

utility

curl --request POST \
  --url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "order_update_v1",
  "category": "UTILITY",
  "language": "en_US",
  "components": [
    {
      "type": "BODY",
      "text": "Hello {{1}}, your order {{2}} has been updated to {{3}}, see you soon.",
      "example": {
        "body_text": [
          [
            "Ana",
            "ORD-1024",
            "in transit"
          ]
        ]
      }
    }
  ]
}
'

200

{
  "id": "1613165359891625",
  "status": "PENDING",
  "category": "UTILITY"
}

​

Conceituação

Este endpoint é escopado por WABA, então hoje cobre só o WhatsApp Oficial.

Instagram e Messenger também têm template pré-aprovado — o Utility Template, escopado por página. O suporte a eles no Omni Z-API está em implementação. Veja a comparação dos três tipos de template.

Cria um novo template de mensagem e envia para aprovação da Meta. O template começa com status PENDING e é atualizado para APPROVED ou REJECTED após a revisão.

Use o endpoint de Sincronizar templates para forçar a atualização do status.

O nome do template deve ser em snake_case, sem espaços ou caracteres especiais. Uma vez criado, o nome não pode ser alterado.

O wabaId é obtido através do endpoint de Listar WABAs.

Autorizações

Authorization · string · header · obrigatório

Secret Key generated in the Omni Z-API Security panel

Parâmetros de caminho

wabaId · string · obrigatório

WABA ID (obtained via List WABAs)

Exemplo:

"428083093730937"

Corpo

application/json

name · string · obrigatório

Template name (snake_case, no spaces)

category · enum<string> · obrigatório

Template category

Opções disponíveis: UTILITY, MARKETING, AUTHENTICATION

language · string · obrigatório

Template language (e.g. en_US, pt_BR)

components · object[] · obrigatório

Template components (HEADER, BODY, FOOTER, BUTTONS)

Resposta

200

application/json

Template created and submitted for approval

id · string

Created template ID

status · enum<string>

Initial status (usually PENDING)

Opções disponíveis: PENDING, APPROVED, REJECTED

category · enum<string>

Created template category

Opções disponíveis: UTILITY, MARKETING, AUTHENTICATION