Criar um template

Cria um novo template de WhatsApp no workspace.

POSThttps://external-api.lip7.com.br/api/external/whatsapp/templates

Escopowhatsapp:templates:writeSíncrono — responde 200 com os dados

Operação síncrona — responde 201 com o template criado.

Body

namestringobrigatório

Nome do template.

contentstringobrigatório

Corpo do template, com variáveis no formato {{1}}.

categorystringopcional

Categoria definida pela Meta.

valoresAUTHENTICATIONMARKETINGUTILITY

mediaUrlstringopcional

URL do cabeçalho de mídia.

mediaTypestringopcional

Tipo da mídia do cabeçalho.

valoresimageaudiovideodocument

variableMappingsarrayopcional

Mapeia cada variável do template para um campo de origem. Cada item tem index (number), source (SYSTEM ou CUSTOM) e fieldId (string).

isActivebooleanopcional

Define se o template fica ativo.

metaDataobjectopcional

Payload no formato esperado pela Meta. Use apenas na API oficial do WhatsApp.

O template nasce como PENDING

Templates criados aqui entram na fila de revisão da Meta. Só é possível enviá-los depois que o status vira APPROVED — veja Status e categorias.

Requisição

{
  "name": "boas_vindas",
  "content": "Olá {{1}}, bem-vindo(a)!",
  "category": "MARKETING",
  "isActive": true
}

{
  "name": "status_pedido",
  "content": "Olá {{1}}, seu pedido {{2}} saiu para entrega.",
  "variableMappings": [
    { "index": 1, "source": "SYSTEM", "fieldId": "firstName" },
    { "index": 2, "source": "CUSTOM", "fieldId": "pedido_id" }
  ]
}

{
  "name": "boas_vindas",
  "content": "Olá {{1}}, bem-vindo(a)!",
  "category": "MARKETING",
  "metaData": {
    "name": "boas_vindas",
    "language": "pt_BR",
    "category": "MARKETING",
    "components": [
      { "type": "BODY", "text": "Olá {{1}}, bem-vindo(a)!" }
    ]
  }
}

Resposta

{
  "success": true,
  "data": {
    "id": "tpl_...",
    "name": "boas_vindas",
    "content": "Olá {{1}}, bem-vindo(a)!",
    "status": "PENDING",
    "category": "MARKETING",
    "isActive": true
  }
}