Skip to main content
A API Key é o cartão de acesso do prédio: cada escopo abre uma porta. Em produção, libere só o que sua integração precisa.

​
Em poucas palavras

  • Toda chave pertence a um workspace.
  • Escopos whatsapp:* cobrem instâncias, envio e leitura do canal.
  • O campo instanceIds restringe quais números a chave pode usar.
  • Contatos, tags e templates multicanal usam escopos à parte (só se precisar).
Guia geral: Chaves de API. Conexão: Quick Start.

​
Como enviar a chave

Alternativa: x-api-key: sk_live_xxxxx.
Escopos vazios na criação = acesso ADMIN (tudo). Em produção, restrinja sempre.

​
Combinações prontas

Conectar e enviar

whatsapp:instances:create, whatsapp:instances:list, whatsapp:send

Só enviar

whatsapp:send + instanceIds com o id do número

Bot / atendimento

whatsapp:send, whatsapp:read

Operar o número

whatsapp:instances:list, whatsapp:instances:disconnect, whatsapp:instances:delete

​
Escopos disponíveis

Listar instâncias, ver detalhes e obter código/QR.
Criar instância (oficial ou não oficial, com ou sem link compartilhável).
Desconectar sessão ativa.
Remover instância (somente desconectada).
Enviar texto, mídia, template, botões e listas.
Histórico de enviadas, status por id e mensagens recebidas (inbound).
Editar mensagem enviada.
Cancelar agendada ou na fila.
Apagar para todos.
Grupos, participantes, convites e envio para JID de grupo. Requer instância não oficial. Guia: Grupos WhatsApp.

​
Limitar por número (instanceIds)

Além do escopo (o que), instanceIds define onde: Exemplo: ERP que só envia pelo suporte → whatsapp:send + instanceIds: ["clxx123..."].

​
Outros escopos (se precisar)

Enviar por template (POST /v1/templates/send) usa whatsapp:send (e outros canais), não templates:*. Detalhes: API de Templates.

​
Erros comuns

Mais códigos: Respostas de erro.

​
Próximos passos