Equipes

Gerencie equipes de atendimento e seus membros via API.

GET

Listar Equipes

Retorna todas as equipes da conta.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams
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}/teams \
  --header 'api_access_token: '
200
[
  {
    "id": 1,
    "name": "Suporte Técnico",
    "description": "Time de suporte técnico",
    "allow_auto_assign": true,
    "is_member": true
  }
]
POST

Criar Equipe

Cria uma nova equipe de atendimento.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Body Parameters
name string obrigatório
Nome da equipe.
description string
Descrição da equipe.
allow_auto_assign boolean
Permite atribuição automática para a equipe.
CURL
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Vendas",
  "description": "Time de vendas"
}'
200
{
  "id": 2,
  "name": "Vendas",
  "description": "Time de vendas"
}
GET

Listar Membros da Equipe

Retorna todos os agentes de uma equipe.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams/{team_id}/team_members
Parâmetros de Path
account_id integer obrigatório
ID da conta.
team_id integer obrigatório
ID da equipe.
CURL
curl --request GET \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams/{team_id}/team_members \
  --header 'api_access_token: '
200
[
  {
    "id": 1,
    "name": "João Silva",
    "role": "agent"
  }
]
POST

Adicionar Agentes à Equipe

Adiciona agentes a uma equipe existente.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams/{team_id}/team_members
Parâmetros de Path
account_id integer obrigatório
ID da conta.
team_id integer obrigatório
ID da equipe.
Body Parameters
user_ids array obrigatório
Array com os IDs dos agentes a adicionar.
CURL
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/teams/{team_id}/team_members \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_ids": [1, 2, 3]
}'
200
[
  {"id": 1, "name": "João Silva"},
  {"id": 2, "name": "Maria Santos"}
]