Comece aqui

Permissões e privacidade

Nesta página

Cada chave tem uma lista de permissões. Sem a permissão de uma rota, a API responde 403 e o texto do erro diz qual falta. A chave nunca acessa outra empresa.

Permissão	O que libera
`conversations:read`	Listar e abrir conversas e ver os números de WhatsApp.
`conversations:write`	Iniciar conversa, transferir, trocar o setor, arquivar e marcar como lida.
`messages:read`	Ler as mensagens de uma conversa e o link dos arquivos.
`messages:send`	Enviar mensagem de texto ou com anexo pelo WhatsApp.
`media:write`	Enviar um arquivo para anexar à mensagem.
`contacts:read`	Consultar contatos e etiquetas.
`contacts:write`	Criar e editar contatos e as etiquetas deles.
`attendances:read`	Atendimentos (protocolos), atendimento da conversa e histórico de responsáveis.
`attendances:write`	Finalizar o atendimento de uma conversa.
`team:read`	Equipe, setores e regras de atendimento.
`reports:read`	Relatório de atendimento do gestor.
`webhooks:manage`	Cadastrar, testar, redefinir o segredo e apagar webhooks.
`read`	Consultar quadros, etapas e cartões.
`create`	Criar cartões nos quadros selecionados.
`update`	Editar título, descrição, prioridade, prazo e etiquetas.
`move`	Mover cartões entre etapas do mesmo quadro.
`comments:write`	Adicionar comentários ao cartão.
`checklist:write`	Adicionar itens e atualizar seu texto ou conclusão.
`attachments:write`	Anexar arquivos e textos aos cartões (até 10 por chamada).
`attachments:delete`	Remover anexos de um cartão.

A chave age como quem a criou

A chave enxerga o que a pessoa que a criou enxerga: os números, as conversas e os quadros dela. Ela deixa de valer quando essa pessoa é desativada ou perde o papel de proprietário ou administrador.

Para integrar sistemas, crie a chave com uma conta de administrador sem número privado: números privados (pessoais) aparecem para o dono deles, inclusive pela chave dele.
A chave é um sistema, não uma pessoa: ela nunca assume conversas nem vira responsável. Enviar mensagem por ela não muda quem atende.
Toda ação pela chave fica registrada com o nome da integração.

Kanban

Para o Kanban, a chave também tem uma lista de quadros: ela só enxerga os quadros escolhidos. Quadros privados ficam fora, e cartões privados ou ligados a números privados não saem pela API. Uma permissão de visualizar no quadro permite somente leituras, mesmo que a chave tenha escopos de escrita. As respostas do Kanban não incluem mensagens, telefones, contatos nem valores monetários.

A API não cria quadros ou etapas e não apaga cartões (arquive-os). Para acompanhar mudanças sem varrer o quadro, use o feed GET /kanban/events com cursor ou um webhook.