Pular para o conteúdo principal
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
teams
/
{team_id}
/
team_members
Atualizar agentees em Team
curl --request PATCH \
  --url https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "user_ids": [
    1
  ]
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members"

payload = { "user_ids": [1] }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_ids: [1]})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'user_ids' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members"

payload := strings.NewReader("{\n \"user_ids\": [\n 1\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("api_access_token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_ids\": [\n 1\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/teams/{team_id}/team_members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_ids\": [\n 1\n ]\n}"

response = http.request(request)
puts response.read_body
[
  {
    "id": 123,
    "account_id": 123,
    "auto_offline": true,
    "confirmed": true,
    "email": "<string>",
    "available_name": "<string>",
    "name": "<string>",
    "thumbnail": "<string>",
    "custom_role_id": 123
  }
]
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

team_id
integer
obrigatório

O ID da equipe a ser atualizada

Corpo

application/json
user_ids
integer[]
obrigatório

IDs dos usuários a serem adicionados à equipe

Exemplo:
[1]

Resposta

Sucesso

id
integer
account_id
integer
availability_status
enum<string>

O status de disponibilidade do agente calculado pelo Chatwoot.

Opções disponíveis:
available,
busy,
offline
auto_offline
boolean

Se o status de disponibilidade do agente está configurado para ficar offline automaticamente quando ausente.

confirmed
boolean

Se o agente confirmou o endereço de e-mail.

email
string

O e-mail do agente

available_name
string

O nome disponível do agente

name
string

O nome do agente

role
enum<string>

A função do agente

Opções disponíveis:
agent,
administrator
thumbnail
string

A miniatura do agente

custom_role_id
integer | null

O id de função personalizada do agente