Equipe e permissões
Pessoas, convites, equipes e atribuição de conversas.
São três permissões separadas: equipe:ler (pessoas, presença, convites abertos e equipes), equipe:escrever (equipes e atribuição de conversas) e equipe:permissoes (convidar, mudar permissões e remover). A última é sensível: o botão "Tudo" da tela de chaves não a marca, você marca de propósito.
- A chave nunca tem mais poder que um gestor e só mexe em atendentes. Dono e gestor aparecem nas listas, mas mudar, remover ou convidar alguém como dono ou gestor dá
403 sem_permissao, mesmo que a chave tenha sido criada por um dono. - O papel (atendente, gestor, dono) nunca muda pela API. Dá para mudar o papel de acesso, os WhatsApps visíveis, os módulos e a agenda de um atendente.
- Convite: a resposta traz o
linkuma única vez e o e-mail sai como na tela (mandeenviar_email: falsepara só pegar o link). Vale 7 dias e conta no limite de acessos do plano. Até 20 convites por dia por organização e 3 por dia para o mesmo e-mail. Reenviar troca o link: o antigo para de valer. - Não existe desativar: remover tira o acesso na hora e as conversas da pessoa ficam sem responsável. Para voltar, convide de novo.
- Atribuir conversa tem o mesmo efeito da tela: fica no histórico da conversa com o nome da chave, a pessoa recebe o aviso, o agente de IA pausa naquela conversa e sai o webhook
conversa.atribuida. - Eventos de webhook:
membro.convidado,membro.entrou,membro.alterado(traz tambémanterior) emembro.removido. - Toda mudança fica na auditoria da organização com o nome da chave. Ids de outra organização dão
404. - Fora da API de propósito: mudar papel, qualquer coisa com dono ou gestor, transferir a organização, plano e cobrança, horário e presença de cada pessoa (só leitura) e papéis de acesso (só pelo app).
Endpoints#
- GETListar pessoas da equipe
/equipe/membros - GETVer uma pessoa
/equipe/membros/{id} - PATCHMudar permissões de um atendente
/equipe/membros/{id} - DELTirar um atendente da equipe
/equipe/membros/{id} - GETQuem está disponível
/equipe/presenca - GETListar convites abertos
/equipe/convites - POSTConvidar atendente
/equipe/convites - DELCancelar convite
/equipe/convites/{id} - POSTReenviar convite
/equipe/convites/{id}/reenviar - GETListar equipes (setores)
/equipe/equipes - POSTCriar equipe
/equipe/equipes - GETVer uma equipe
/equipe/equipes/{id} - PATCHAtualizar equipe
/equipe/equipes/{id} - DELApagar equipe
/equipe/equipes/{id} - PATCHPôr e tirar pessoas da equipe
/equipe/equipes/{id}/membros - POSTAtribuir ou transferir conversa
/conversas/{id}/atribuir
Códigos de erro#
Além dos gerais (chave, limite, JSON), estes podem vir em erro.codigo nas rotas daqui. Todos estão em Erros.
| codigo | O que significa |
|---|---|
| sem_permissao | A chave de API não pode fazer isso. Veja o motivo em "detalhe". |
| ja_e_membro | Esse e-mail já é de alguém da equipe. |
| limite_de_acessos | O plano chegou ao limite de acessos (pessoas + convites abertos). Remova alguém ou cancele um convite. |
| limite_de_convites | Limite de convites: 20 por dia por organização e 3 por dia para o mesmo e-mail. Tente amanhã. |
| membro_inexistente | Pessoa não encontrada nesta organização (veja GET /equipe/membros). |
| convite_inexistente | Convite não encontrado, já aceito ou vencido (veja GET /equipe/convites). |
| equipe_inexistente | Equipe não encontrada (veja GET /equipe/equipes). |
| equipe_repetida | Já existe uma equipe com esse nome. |
| papel_inexistente | Papel de acesso não encontrado nesta organização. |
| modulos_do_papel | Com papel de acesso, os módulos e a agenda vêm do papel. Mande papel_de_acesso_id: null para escolher à mão. |
| modulo_invalido | Módulo inválido. Use conversas, contatos, automacoes, agentes, funil, agenda, followup ou relatorios. |
| conversa_inexistente | Conversa não encontrada. |