Pular para o conteúdo
POST/equipe/convites

Convidar atendente

equipe:permissoesaceita Idempotency-Key

Manda o e-mail de convite (como a tela) e responde com o link UMA vez. Vale 7 dias. Só atendente. Conta no limite de acessos do plano. Até 20 convites por dia por organização e 3 por e-mail (429 limite_de_convites). Repetir com a mesma Idempotency-Key devolve o convite sem link e sem mandar outro e-mail. Dispara membro.convidado.

POST /equipe/convites

curl -X POST "https://chat.forsi.com.br/api/v1/equipe/convites" \
  -H "Authorization: Bearer $FORSI_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-4821" \
  -d '{"email":"nova.atendente@exemplo.com.br","enviar_email":true}'
Resposta 201
{
  "dados": {
    "id": "fac480ff-6cc4-47be-9a87-6270d519a659",
    "email": "nova.atendente@exemplo.com.br",
    "papel": "dono",
    "papel_de_acesso_id": "646adc88-610e-4604-96fe-af5175dca375",
    "convidado_por": "Ana Lima",
    "expira_em": "2026-10-04T13:05:12.481Z",
    "criado_em": "2026-10-04T13:05:12.481Z",
    "link": "https://chat.forsi.com.br/convite/EXEMPLO"
  }
}

Corpo da requisição#

JSON. Mande com Content-Type: application/json.

  • emailstringobrigatório
    • até 254 caracteres
  • papel"atendente"opcional

    Sempre atendente pela API.

  • papel_de_acesso_iduuidopcional

    Papel de acesso aplicado quando a pessoa aceitar.

  • enviar_emailbooleanopcional

    false = não manda o e-mail; use o link da resposta. Padrão: manda.

Resposta#

201 com {"dados": ...}: ConviteComLink.

Erros#

Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.

Status de erro desta operação
StatusQuando
401Chave ausente ou inválida (resposta igual para qualquer motivo).
403Plano sem API, escopo insuficiente ou https/origem recusados.
409Conflito (repetido, Idempotency-Key com outro corpo).
422Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
429Limite de requisições. Veja Retry-After.
Códigos de erro que esta área pode devolver12
  • sem_permissaoA chave de API não pode fazer isso. Veja o motivo em "detalhe".
  • ja_e_membroEsse e-mail já é de alguém da equipe.
  • limite_de_acessosO plano chegou ao limite de acessos (pessoas + convites abertos). Remova alguém ou cancele um convite.
  • limite_de_convitesLimite de convites: 20 por dia por organização e 3 por dia para o mesmo e-mail. Tente amanhã.
  • membro_inexistentePessoa não encontrada nesta organização (veja GET /equipe/membros).
  • convite_inexistenteConvite não encontrado, já aceito ou vencido (veja GET /equipe/convites).
  • equipe_inexistenteEquipe não encontrada (veja GET /equipe/equipes).
  • equipe_repetidaJá existe uma equipe com esse nome.
  • papel_inexistentePapel de acesso não encontrado nesta organização.
  • modulos_do_papelCom papel de acesso, os módulos e a agenda vêm do papel. Mande papel_de_acesso_id: null para escolher à mão.
  • modulo_invalidoMódulo inválido. Use conversas, contatos, automacoes, agentes, funil, agenda, followup ou relatorios.
  • conversa_inexistenteConversa não encontrada.

Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.