Klivo Chat API › Application APIs

Agentes

Gerencie os agentes da sua conta — liste, crie, atualize e remova membros da equipe.

GET

Listar Agentes

Retorna todos os agentes da conta.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents
Parâmetros de Path
account_id integer obrigatório
ID da conta.
CURL 
curl --request GET \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents \
  --header 'api_access_token: '
200 
[
  {
    "id": 1,
    "account_id": 1,
    "name": "João Silva",
    "email": "joao@empresa.com",
    "role": "agent",
    "availability_status": "online",
    "confirmed": true,
    "thumbnail": "https://chat.klivo.marketing/..."
  }
]
POST

Criar Agente

Cria um novo agente e envia o convite por e-mail.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Body Parameters
name string obrigatório
Nome completo do agente.
email string obrigatório
E-mail do agente (será usado para login).
role string obrigatório
Função: agent ou administrator.
CURL 
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "role": "agent"
}'
200 
{
  "id": 2,
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "role": "agent",
  "confirmed": false
}
PATCH

Atualizar Agente

Atualiza o nome ou a função de um agente.

PATCH
https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents/{id}
Parâmetros de Path
account_id integer obrigatório
ID da conta.
id integer obrigatório
ID do agente.
Body Parameters
name string
Novo nome do agente.
role string
Nova função: agent ou administrator.
availability string
Disponibilidade: online, busy, offline.
CURL 
curl --request PATCH \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents/{id} \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "administrator"
}'
200 
{
  "id": 2,
  "name": "Maria Santos",
  "role": "administrator"
}
DELETE

Remover Agente

Remove um agente da conta. As conversas atribuídas ficarão sem atribuição.

DELETE
https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents/{id}
Parâmetros de Path
account_id integer obrigatório
ID da conta.
id integer obrigatório
ID do agente.
CURL 
curl --request DELETE \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/agents/{id} \
  --header 'api_access_token: '
200 
{
  "message": "Agent deleted"
}