Quick Start - Notifique

Do zero ao primeiro disparo na fila: crie o template, ligue os canais que precisa e chame POST /v1/templates/send. Gestão (templates:*) e envio (escopos por canal) são famílias diferentes de permissão.

Em poucas palavras

Um template não precisa ter os sete canais, ligue só os que for usar.
No envio, channels deve ser subconjunto dos canais habilitados no template.
Resposta 202 = enfileirado. Entrega → webhooks de cada canal. Aprovação Meta → webhooks template.*.

Contexto: Introdução. Escopos: Escopos da API Key. WhatsApp oficial: Templates oficiais Meta.

Antes de começar

Gestão: templates:create (criar), templates:read (listar)
Envio: escopo de cada canal usado (sms:send, email:send, whatsapp:send, …)
WhatsApp: instância ativa. E-mail: domínio verificado. Push: app. Voz: número ACTIVE
Auth: Authorization: Bearer sk_live_... ou x-api-key
Base URL: https://api.notifique.dev

1. Criar template

1A, Pelo painel

Templates → Novo template
Ligue os canais (SMS, e-mail, WhatsApp, …)
Escreva o conteúdo com {{variáveis}} e salve

Para WhatsApp oficial: após criar, use Sincronizar ou Publicar na Meta na instância oficial, guia completo.

1B, Pela API

Escopo: templates:create.

POST /v1/templates
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "name": "alerta_pedido",
  "category": "TRANSACTIONAL",
  "language": "pt_BR",
  "sms": {
    "enabled": true,
    "payload": { "content": "Pedido {{codigo}} despachado." }
  },
  "email": {
    "enabled": true,
    "payload": {
      "subject": "Pedido {{codigo}}",
      "html": "<p>Olá {{name}}, seu pedido saiu.</p>"
    }
  },
  "whatsapp": { "enabled": false, "payload": {} },
  "telegram": { "enabled": false, "payload": {} },
  "rcs": { "enabled": false, "payload": {} },
  "push": { "enabled": false, "payload": {} },
  "voice": { "enabled": false, "payload": {} }
}

Resposta esperada: 200 com enabledChannels (ex.: ["email","sms"]).

Canal com enabled: false usa payload: {}. Pedir canal desabilitado no envio → 400 (TEMPLATE_CHANNEL_NOT_ENABLED).

Payloads dos outros canais: Variáveis e CRUD.

2. Enviar por template

Escopos neste exemplo: sms:send, email:send.

POST /v1/templates/send
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "template": "alerta_pedido",
  "channels": ["sms", "email"],
  "to": ["5511999999999", "cliente@email.com"],
  "variables": {
    "codigo": "12345",
    "name": "Maria"
  },
  "from": "ola@meudominio.com.br",
  "fromName": "Equipe Notifique"
}

Resposta esperada: 202

{
  "success": true,
  "data": {
    "smsIds": ["clsms1..."],
    "emailIds": ["clemail1..."],
    "status": "QUEUED",
    "count": 2
  }
}

Só aparecem IDs dos canais que geraram envio. Campos por canal: messageIds (WhatsApp), smsIds, emailIds, telegramIds, rcsIds, pushIds, voiceCallIds.

WhatsApp no mesmo template

Inclua whatsapp em channels e informe instanceId (se não houver padrão no workspace):

{
  "template": "alerta_pedido",
  "channels": ["whatsapp", "sms"],
  "to": ["5511999999999"],
  "variables": { "codigo": "12345", "name": "Maria" },
  "instanceId": "cuid_instancia_whatsapp"
}

Linha oficial: o template precisa estar vinculado/aprovado na Meta (WHATSAPP_OFFICIAL, status APPROVED). Veja Templates oficiais Meta.

Push e Voz

Push: channels: ["push"] + push.pushAppId + device IDs em to
Voz: channels: ["voice"] + voice.from + números com + em to

3. Campos principais do envio

Campo	Obrigatório	Descrição
`template`	Sim	ID ou nome do template
`channels`	Sim	Canais habilitados no template
`to`	Sim	Até 100 destinatários
`variables`	Conforme template	Valores para `{{chave}}`
`instanceId`	Se WA sem padrão	Instância WhatsApp
`from` / `fromName`	Se e-mail sem padrão	Remetente verificado
`push.pushAppId`	Se `push`	App de push
`voice.from`	Se `voice`	Número de origem
`schedule.sendAt`	Não	Agenda (ISO 8601)

4. Acompanhar resultado

O que	Onde
Entrega SMS, e-mail, WhatsApp…	Webhooks do canal (`sms.delivered`, `message.sent`, …)
Meta aprovou/rejeitou template	Webhooks *`template.`**, Eventos dos webhooks
Erros de validação / Meta	Respostas de erro

Erros comuns

HTTP	Significado
400	Canal não habilitado, variável faltando, template Meta não aprovado
403	Escopo ausente ou créditos insuficientes
404	Template, instância ou app não encontrado

Próximos passos

Templates oficiais Meta: sync e aprovação
Variáveis e CRUD: merge e edição
Escopos: permissões
Eventos dos webhooks: template.*

​Em poucas palavras

​Antes de começar

​1. Criar template

​1A, Pelo painel

​1B, Pela API

​2. Enviar por template

​WhatsApp no mesmo template

​Push e Voz

​3. Campos principais do envio

​4. Acompanhar resultado

​Erros comuns

​Próximos passos

Em poucas palavras

Antes de começar

1. Criar template

1A, Pelo painel

1B, Pela API

2. Enviar por template

WhatsApp no mesmo template

Push e Voz

3. Campos principais do envio

4. Acompanhar resultado

Erros comuns

Próximos passos