Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lfautomatiza.com/llms.txt

Use this file to discover all available pages before exploring further.

Agentes são os atendentes individuais da conta. Equipes (teams) agrupam agentes por especialidade ou departamento — útil pra rotear conversas por área (Vendas, Suporte, Financeiro, etc.).

​
Agentes

​
Listar

GET /api/v1/accounts/{account_id}/agents

curl https://chat.lfautomatiza.com/api/v1/accounts/1/agents \
  -H "api_access_token: $TOKEN"
Retorna todos os agentes da conta com role (administrator | agent), status de disponibilidade e métricas básicas.

​
Convidar agente

POST /api/v1/accounts/{account_id}/agents
CampoTipoDescrição
emailstringE-mail do novo agente
namestringNome
roleenumadministrator ou agent
curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/agents \
  -H "api_access_token: $TOKEN" \
  -d '{
    "email": "novo.atendente@empresa.com",
    "name": "Maria Souza",
    "role": "agent"
  }'
O agente recebe e-mail com link de ativação. Até ativar, fica como pending.

​
Atualizar permissão

PATCH /api/v1/accounts/{account_id}/agents/{id}

curl -X PATCH https://chat.lfautomatiza.com/api/v1/accounts/1/agents/7 \
  -H "api_access_token: $TOKEN" \
  -d '{ "role": "administrator" }'

​
Remover agente

DELETE /api/v1/accounts/{account_id}/agents/{id}
Remove o agente da conta. Conversas atribuídas a ele ficam sem agente (precisam ser reatribuídas).

​
Equipes (Teams)

​
Listar

GET /api/v1/accounts/{account_id}/teams

​
Criar equipe

POST /api/v1/accounts/{account_id}/teams

curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/teams \
  -H "api_access_token: $TOKEN" \
  -d '{
    "name": "Comercial",
    "description": "Equipe de vendas inbound e outbound",
    "allow_auto_assign": true
  }'
CampoTipoDescrição
namestringNome da equipe
descriptionstringTexto livre
allow_auto_assignbooleanLiga distribuição automática para os membros

​
Detalhe / atualizar / excluir

GET    /api/v1/accounts/{account_id}/teams/{id}
PATCH  /api/v1/accounts/{account_id}/teams/{id}
DELETE /api/v1/accounts/{account_id}/teams/{id}

​
Membros da equipe

GET    /api/v1/accounts/{account_id}/teams/{id}/team_members
POST   /api/v1/accounts/{account_id}/teams/{id}/team_members
DELETE /api/v1/accounts/{account_id}/teams/{id}/team_members
Adicionar agentes: 
curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/teams/3/team_members \
  -H "api_access_token: $TOKEN" \
  -d '{ "user_ids": [7, 11, 15] }'
Remover: 
curl -X DELETE https://chat.lfautomatiza.com/api/v1/accounts/1/teams/3/team_members \
  -H "api_access_token: $TOKEN" \
  -d '{ "user_ids": [11] }'

​
Disponibilidade do agente

Status atual de cada agente fica em availability_status quando você lista agentes:
StatusSignificado
onlineDisponível pra receber conversas
busyOcupado (não recebe novas atribuições automáticas)
offlineDesconectado
Distribuição automática só atribui conversas pra agentes online.

​
Papéis (role)

RolePermissões
administratorTudo: configurações, gestão de equipe, inboxes, integrações
agentSó atende — não muda configurações da conta
Para granularidade maior, use funções personalizadas (custom roles) — disponíveis em planos enterprise.

​
Códigos de resposta

CódigoQuando acontece
200 OKSucesso em GET / PATCH
201 CreatedAgente convidado / equipe criada
204 No ContentRemovido com sucesso
403 ForbiddenApenas administrador pode gerenciar agentes/equipes
404 Not FoundRecurso não existe
422 Unprocessable EntityE-mail já vinculado a outra conta