Pular para o conteúdo

Escopos e planos

Cada chave tem só os escopos marcados na criação. Chamada fora deles dá 403 escopo_insuficiente (o escopo que faltou vem em detalhe). GET /me aceita qualquer chave válida.

EscopoO que liberaRotas
mensagens:enviarEnviar mensagens (texto, mídia e modelos)POST /mensagens
mensagens:lerLer mensagens das conversasGET /mensagens, GET /mensagens/{id}, GET /mensagens/{id}/midia, GET /conversas/{id}/mensagens
contatos:lerLer e buscar contatosGET /contatos, GET /contatos/{id}
contatos:escreverCriar, editar e apagar contatosPOST /contatos, PATCH /contatos/{id}, DELETE /contatos/{id}
conversas:lerListar e ler conversasGET /conversas, GET /conversas/{id}
modelos:lerListar modelos aprovados do WhatsAppGET /modelos
webhooks:gerirCadastrar e gerir webhooksGET /webhooks, POST /webhooks, GET /webhooks/{id}, PATCH /webhooks/{id}, DELETE /webhooks/{id}, POST /webhooks/{id}/rotacionar, POST /webhooks/{id}/testar, GET /webhooks/{id}/entregas, POST /webhooks/entregas/{id}/reenviar
funil:lerLer funis, etapas, negócios e notasGET /funis, GET /funis/{id}, GET /etapas/{id}, GET /negocios, GET /negocios/{id}, GET /negocios/{id}/notas
funil:escreverCriar e editar funis, etapas e negócios; mover, ganhar, perder e anotarPOST /funis, PATCH /funis/{id}, POST /etapas, PATCH /etapas/{id}, POST /negocios, PATCH /negocios/{id}, POST /negocios/{id}/mover, POST /negocios/{id}/ganhar, POST /negocios/{id}/perder, POST /negocios/{id}/reabrir, POST /negocios/{id}/notas
funil:apagarApagar negócios, notas, etapas e funis (sem volta)DELETE /funis/{id}, DELETE /etapas/{id}, DELETE /negocios/{id}, DELETE /negocios/notas/{id}
relatorios:lerLer relatórios: volume, tempo de resposta, equipe, caixas, agente de IA e créditos usadosGET /relatorios/volume, GET /relatorios/tempo-de-resposta, GET /relatorios/atendentes, GET /relatorios/caixas, GET /relatorios/agente-de-ia, GET /relatorios/creditos
agenda:lerLer agendas, horários livres, compromissos e bloqueiosGET /agendas, GET /agendas/{id}, GET /disponibilidade, GET /compromissos, GET /compromissos/{id}, GET /bloqueios, GET /bloqueios/{id}
agenda:escreverCriar e editar agendas e bloqueios; marcar, remarcar, confirmar, cancelar e dar presença em compromissos (não apaga nada)POST /agendas, PATCH /agendas/{id}, POST /compromissos, PATCH /compromissos/{id}, POST /compromissos/{id}/remarcar, POST /compromissos/{id}/cancelar, POST /compromissos/{id}/confirmar, POST /bloqueios, PATCH /bloqueios/{id}, DELETE /bloqueios/{id}
equipe:lerLer pessoas da equipe, presença, convites abertos e equipes (setores)GET /equipe/membros, GET /equipe/membros/{id}, GET /equipe/presenca, GET /equipe/convites, GET /equipe/equipes, GET /equipe/equipes/{id}
equipe:escreverCriar, editar e apagar equipes (setores), pôr e tirar pessoas delas e atribuir conversasPOST /equipe/equipes, PATCH /equipe/equipes/{id}, DELETE /equipe/equipes/{id}, PATCH /equipe/equipes/{id}/membros, POST /conversas/{id}/atribuir
equipe:permissoes (sensível)Convidar atendentes, reenviar e cancelar convites, mudar permissões e remover atendentes (nunca mexe em dono ou gestor)PATCH /equipe/membros/{id}, DELETE /equipe/membros/{id}, POST /equipe/convites, DELETE /equipe/convites/{id}, POST /equipe/convites/{id}/reenviar
automacoes:lerLer regras de comentário do Instagram, contas conectadas e automaçõesGET /instagram/contas, GET /automacoes, GET /regras-comentario, GET /regras-comentario/{id}
automacoes:escrever (sensível)Criar, editar, ligar, desligar e apagar regras de comentário do InstagramPOST /regras-comentario, PATCH /regras-comentario/{id}, DELETE /regras-comentario/{id}

Plano#

  • Tudo exige o módulo API no plano da organização. Sem ele, qualquer chamada dá 403 modulo_fora_do_plano e os webhooks param.
  • Funil e negócios exigem também o módulo Funil; agenda exige o módulo Agenda. A checagem é a cada chamada: downgrade corta na hora.
  • Assinatura suspensa: 403 assinatura_bloqueada.
  • Os limites de uso valem para o plano atual (veja Limites de uso).