Logo

Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

Enviar template

POSTEnviar/api/external/whatsapp/templates/send

Envia um template aprovado para um numero de WhatsApp.

Escopo: whatsapp:sendAssincrono — responde 202 com requestId

Por ser um envio, e assincrono: responde 202 com requestId. Acompanhe em /usage/status/{requestId} ou por webhook. Suporta Idempotency-Key — veja Idempotencia.

Body
tostringobrigatorio

Numero do destinatario (DDI 55).

templateNamestringobrigatorio

Nome do template aprovado.

languagestringopcionaldefault: pt_BR

Idioma do template. A Meta exige idioma no envio; se omitido, usamos pt_BR.

templateParamsobjectopcional

Variaveis do corpo do template. Os valores sao enviados na ordem das chaves — use chaves numericas em string ("1", "2", "3") para garantir a ordem.

templateButtonParamsarrayopcional

Preenche botoes do tipo url ou quick_reply. Para botao url, o text e obrigatorio; index segue o indice configurado no template.

Exemplo:

Resposta (202 Accepted):

Templates (CRUD)

Listar templates

GETBuscar/api/external/whatsapp/templates

Busca os templates de WhatsApp do workspace.

Escopo: whatsapp:templates:readSincrono — responde 200 com os dados

Query params:

  • category (string)
  • isActive (boolean)
  • search (string)
  • page (number)
  • limit (number)

Resposta:

Obter template

GETBuscar/api/external/whatsapp/templates/{id}

Busca um template pelo id.

Escopo: whatsapp:templates:readSincrono — responde 200 com os dados

Resposta (exemplo):

Criar template

POSTCriar/api/external/whatsapp/templates

Cria um novo template. Operacao sincrona — responde 201 com o template criado.

Escopo: whatsapp:templates:writeSincrono — responde 200 com os dados

Campos principais:

  • name (string, obrigatorio)
  • content (string, obrigatorio)
  • category (string, opcional)
  • mediaUrl (string, opcional)
  • mediaType (string, opcional: image|audio|video|document)
  • variableMappings (array, opcional)
  • isActive (boolean, opcional)

variableMappings:

  • index (number)
  • source (SYSTEM | CUSTOM)
  • fieldId (string)

Exemplo (criacao simples):

Exemplo com variableMappings:

Opcional (apenas para API oficial do WhatsApp):

  • metaData com o payload esperado pela Meta

Exemplo com metaData:

Atualizar template

PUTSubstituir/api/external/whatsapp/templates/{id}

Atualiza um template existente.

Escopo: whatsapp:templates:writeSincrono — responde 200 com os dados

Excluir template

DELETERemover/api/external/whatsapp/templates/{id}

Remove um template do workspace.

Escopo: whatsapp:templates:writeSincrono — responde 200 com os dados

Status e categorias

Categorias (Meta):

  • AUTHENTICATION
  • MARKETING
  • UTILITY

Status (Meta):

  • PENDING
  • APPROVED
  • REJECTED
  • PAUSED
  • DISABLED

Última atualização

15 de junho de 2026

Editar esta página no GitHub