# Escopos e planos

> O que cada escopo de chave da API do FORSI Chat libera, quais são sensíveis e que módulo o plano precisa ter para cada um.

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`](https://docs.forsi.com.br/api/conta/me) aceita qualquer chave válida.

| Escopo | O que libera | Rotas |
| --- | --- | --- |
| `mensagens:enviar` | Enviar mensagens (texto, mídia e modelos) | [`POST /mensagens`](https://docs.forsi.com.br/api/mensagens/enviar-mensagem) |
| `mensagens:ler` | Ler mensagens das conversas | [`GET /mensagens`](https://docs.forsi.com.br/api/mensagens/listar-mensagens-org), [`GET /mensagens/{id}`](https://docs.forsi.com.br/api/mensagens/ver-mensagem), [`GET /mensagens/{id}/midia`](https://docs.forsi.com.br/api/mensagens/baixar-midia), [`GET /conversas/{id}/mensagens`](https://docs.forsi.com.br/api/conversas/listar-mensagens) |
| `contatos:ler` | Ler e buscar contatos | [`GET /contatos`](https://docs.forsi.com.br/api/contatos/listar-contatos), [`GET /contatos/{id}`](https://docs.forsi.com.br/api/contatos/ver-contato) |
| `contatos:escrever` | Criar, editar e apagar contatos | [`POST /contatos`](https://docs.forsi.com.br/api/contatos/criar-contato), [`PATCH /contatos/{id}`](https://docs.forsi.com.br/api/contatos/atualizar-contato), [`DELETE /contatos/{id}`](https://docs.forsi.com.br/api/contatos/apagar-contato) |
| `conversas:ler` | Listar e ler conversas | [`GET /conversas`](https://docs.forsi.com.br/api/conversas/listar-conversas), [`GET /conversas/{id}`](https://docs.forsi.com.br/api/conversas/ver-conversa) |
| `modelos:ler` | Listar modelos aprovados do WhatsApp | [`GET /modelos`](https://docs.forsi.com.br/api/modelos/listar-modelos) |
| `webhooks:gerir` | Cadastrar e gerir webhooks | [`GET /webhooks`](https://docs.forsi.com.br/api/webhooks/listar-webhooks), [`POST /webhooks`](https://docs.forsi.com.br/api/webhooks/criar-webhook), [`GET /webhooks/{id}`](https://docs.forsi.com.br/api/webhooks/ver-webhook), [`PATCH /webhooks/{id}`](https://docs.forsi.com.br/api/webhooks/atualizar-webhook), [`DELETE /webhooks/{id}`](https://docs.forsi.com.br/api/webhooks/apagar-webhook), [`POST /webhooks/{id}/rotacionar`](https://docs.forsi.com.br/api/webhooks/rotacionar-webhook), [`POST /webhooks/{id}/testar`](https://docs.forsi.com.br/api/webhooks/testar-webhook), [`GET /webhooks/{id}/entregas`](https://docs.forsi.com.br/api/webhooks/listar-entregas), [`POST /webhooks/entregas/{id}/reenviar`](https://docs.forsi.com.br/api/webhooks/reenviar-entrega) |
| `funil:ler` | Ler funis, etapas, negócios e notas | [`GET /funis`](https://docs.forsi.com.br/api/funil/listar-funis), [`GET /funis/{id}`](https://docs.forsi.com.br/api/funil/ver-funil), [`GET /etapas/{id}`](https://docs.forsi.com.br/api/funil/ver-etapa), [`GET /negocios`](https://docs.forsi.com.br/api/funil/listar-negocios), [`GET /negocios/{id}`](https://docs.forsi.com.br/api/funil/ver-negocio), [`GET /negocios/{id}/notas`](https://docs.forsi.com.br/api/funil/listar-notas-negocio) |
| `funil:escrever` | Criar e editar funis, etapas e negócios; mover, ganhar, perder e anotar | [`POST /funis`](https://docs.forsi.com.br/api/funil/criar-funil), [`PATCH /funis/{id}`](https://docs.forsi.com.br/api/funil/atualizar-funil), [`POST /etapas`](https://docs.forsi.com.br/api/funil/criar-etapa), [`PATCH /etapas/{id}`](https://docs.forsi.com.br/api/funil/atualizar-etapa), [`POST /negocios`](https://docs.forsi.com.br/api/funil/criar-negocio), [`PATCH /negocios/{id}`](https://docs.forsi.com.br/api/funil/atualizar-negocio), [`POST /negocios/{id}/mover`](https://docs.forsi.com.br/api/funil/mover-negocio), [`POST /negocios/{id}/ganhar`](https://docs.forsi.com.br/api/funil/ganhar-negocio), [`POST /negocios/{id}/perder`](https://docs.forsi.com.br/api/funil/perder-negocio), [`POST /negocios/{id}/reabrir`](https://docs.forsi.com.br/api/funil/reabrir-negocio), [`POST /negocios/{id}/notas`](https://docs.forsi.com.br/api/funil/criar-nota-negocio) |
| `funil:apagar` | Apagar negócios, notas, etapas e funis (sem volta) | [`DELETE /funis/{id}`](https://docs.forsi.com.br/api/funil/apagar-funil), [`DELETE /etapas/{id}`](https://docs.forsi.com.br/api/funil/apagar-etapa), [`DELETE /negocios/{id}`](https://docs.forsi.com.br/api/funil/apagar-negocio), [`DELETE /negocios/notas/{id}`](https://docs.forsi.com.br/api/funil/apagar-nota-negocio) |
| `relatorios:ler` | Ler relatórios: volume, tempo de resposta, equipe, caixas, agente de IA e créditos usados | [`GET /relatorios/volume`](https://docs.forsi.com.br/api/relatorios/relatorio-volume), [`GET /relatorios/tempo-de-resposta`](https://docs.forsi.com.br/api/relatorios/relatorio-tempo-de-resposta), [`GET /relatorios/atendentes`](https://docs.forsi.com.br/api/relatorios/relatorio-atendentes), [`GET /relatorios/caixas`](https://docs.forsi.com.br/api/relatorios/relatorio-caixas), [`GET /relatorios/agente-de-ia`](https://docs.forsi.com.br/api/relatorios/relatorio-agente-de-ia), [`GET /relatorios/creditos`](https://docs.forsi.com.br/api/relatorios/relatorio-creditos) |
| `agenda:ler` | Ler agendas, horários livres, compromissos e bloqueios | [`GET /agendas`](https://docs.forsi.com.br/api/agenda/listar-agendas), [`GET /agendas/{id}`](https://docs.forsi.com.br/api/agenda/ver-agenda), [`GET /disponibilidade`](https://docs.forsi.com.br/api/agenda/disponibilidade), [`GET /compromissos`](https://docs.forsi.com.br/api/agenda/listar-compromissos), [`GET /compromissos/{id}`](https://docs.forsi.com.br/api/agenda/ver-compromisso), [`GET /bloqueios`](https://docs.forsi.com.br/api/agenda/listar-bloqueios), [`GET /bloqueios/{id}`](https://docs.forsi.com.br/api/agenda/ver-bloqueio) |
| `agenda:escrever` | Criar e editar agendas e bloqueios; marcar, remarcar, confirmar, cancelar e dar presença em compromissos (não apaga nada) | [`POST /agendas`](https://docs.forsi.com.br/api/agenda/criar-agenda), [`PATCH /agendas/{id}`](https://docs.forsi.com.br/api/agenda/atualizar-agenda), [`POST /compromissos`](https://docs.forsi.com.br/api/agenda/criar-compromisso), [`PATCH /compromissos/{id}`](https://docs.forsi.com.br/api/agenda/atualizar-compromisso), [`POST /compromissos/{id}/remarcar`](https://docs.forsi.com.br/api/agenda/remarcar-compromisso), [`POST /compromissos/{id}/cancelar`](https://docs.forsi.com.br/api/agenda/cancelar-compromisso), [`POST /compromissos/{id}/confirmar`](https://docs.forsi.com.br/api/agenda/confirmar-compromisso), [`POST /bloqueios`](https://docs.forsi.com.br/api/agenda/criar-bloqueio), [`PATCH /bloqueios/{id}`](https://docs.forsi.com.br/api/agenda/atualizar-bloqueio), [`DELETE /bloqueios/{id}`](https://docs.forsi.com.br/api/agenda/apagar-bloqueio) |
| `equipe:ler` | Ler pessoas da equipe, presença, convites abertos e equipes (setores) | [`GET /equipe/membros`](https://docs.forsi.com.br/api/equipe/listar-membros), [`GET /equipe/membros/{id}`](https://docs.forsi.com.br/api/equipe/ver-membro), [`GET /equipe/presenca`](https://docs.forsi.com.br/api/equipe/listar-presenca), [`GET /equipe/convites`](https://docs.forsi.com.br/api/equipe/listar-convites), [`GET /equipe/equipes`](https://docs.forsi.com.br/api/equipe/listar-equipes), [`GET /equipe/equipes/{id}`](https://docs.forsi.com.br/api/equipe/ver-equipe) |
| `equipe:escrever` | Criar, editar e apagar equipes (setores), pôr e tirar pessoas delas e atribuir conversas | [`POST /equipe/equipes`](https://docs.forsi.com.br/api/equipe/criar-equipe), [`PATCH /equipe/equipes/{id}`](https://docs.forsi.com.br/api/equipe/atualizar-equipe), [`DELETE /equipe/equipes/{id}`](https://docs.forsi.com.br/api/equipe/apagar-equipe), [`PATCH /equipe/equipes/{id}/membros`](https://docs.forsi.com.br/api/equipe/atualizar-membros-equipe), [`POST /conversas/{id}/atribuir`](https://docs.forsi.com.br/api/equipe/atribuir-conversa) |
| `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}`](https://docs.forsi.com.br/api/equipe/atualizar-membro), [`DELETE /equipe/membros/{id}`](https://docs.forsi.com.br/api/equipe/remover-membro), [`POST /equipe/convites`](https://docs.forsi.com.br/api/equipe/criar-convite), [`DELETE /equipe/convites/{id}`](https://docs.forsi.com.br/api/equipe/cancelar-convite), [`POST /equipe/convites/{id}/reenviar`](https://docs.forsi.com.br/api/equipe/reenviar-convite) |
| `automacoes:ler` | Ler regras de comentário do Instagram, contas conectadas e automações | [`GET /instagram/contas`](https://docs.forsi.com.br/api/automacoes/listar-contas-instagram), [`GET /automacoes`](https://docs.forsi.com.br/api/automacoes/listar-automacoes-de-comentario), [`GET /regras-comentario`](https://docs.forsi.com.br/api/automacoes/listar-regras-comentario), [`GET /regras-comentario/{id}`](https://docs.forsi.com.br/api/automacoes/ver-regra-comentario) |
| `automacoes:escrever` (sensível) | Criar, editar, ligar, desligar e apagar regras de comentário do Instagram | [`POST /regras-comentario`](https://docs.forsi.com.br/api/automacoes/criar-regra-comentario), [`PATCH /regras-comentario/{id}`](https://docs.forsi.com.br/api/automacoes/editar-regra-comentario), [`DELETE /regras-comentario/{id}`](https://docs.forsi.com.br/api/automacoes/apagar-regra-comentario) |

## 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](https://docs.forsi.com.br/limites)).

---

Página: https://docs.forsi.com.br/escopos · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt