squads
Update Squad
Update a squad with intelligent routing configuration.
PUT
/
squads
/
{squad_id}
Update Squad
curl --request PUT \
--url https://api.example.com/squads/{squad_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"members": [
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"role": "<string>",
"specialization": "<string>",
"skills": [
"<string>"
],
"priority": 1,
"max_concurrent": 123,
"working_hours": {}
}
],
"transfer_rules": [
{
"to_member": "<string>",
"conditions": [
"<string>"
],
"from_member": "<string>",
"priority": 1,
"transfer_type": "warm",
"context_fields": [
"<string>"
]
}
],
"routing_strategy": "<string>",
"status": "<string>",
"default_member": "<string>",
"agents": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.example.com/squads/{squad_id}"
payload = {
"name": "<string>",
"description": "<string>",
"members": [
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"role": "<string>",
"specialization": "<string>",
"skills": ["<string>"],
"priority": 1,
"max_concurrent": 123,
"working_hours": {}
}
],
"transfer_rules": [
{
"to_member": "<string>",
"conditions": ["<string>"],
"from_member": "<string>",
"priority": 1,
"transfer_type": "warm",
"context_fields": ["<string>"]
}
],
"routing_strategy": "<string>",
"status": "<string>",
"default_member": "<string>",
"agents": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
members: [
{
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
role: '<string>',
specialization: '<string>',
skills: ['<string>'],
priority: 1,
max_concurrent: 123,
working_hours: {}
}
],
transfer_rules: [
{
to_member: '<string>',
conditions: ['<string>'],
from_member: '<string>',
priority: 1,
transfer_type: 'warm',
context_fields: ['<string>']
}
],
routing_strategy: '<string>',
status: '<string>',
default_member: '<string>',
agents: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.example.com/squads/{squad_id}', 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://api.example.com/squads/{squad_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'members' => [
[
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'role' => '<string>',
'specialization' => '<string>',
'skills' => [
'<string>'
],
'priority' => 1,
'max_concurrent' => 123,
'working_hours' => [
]
]
],
'transfer_rules' => [
[
'to_member' => '<string>',
'conditions' => [
'<string>'
],
'from_member' => '<string>',
'priority' => 1,
'transfer_type' => 'warm',
'context_fields' => [
'<string>'
]
]
],
'routing_strategy' => '<string>',
'status' => '<string>',
'default_member' => '<string>',
'agents' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/squads/{squad_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/squads/{squad_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/squads/{squad_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"agents": [
{}
],
"routing_strategy": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"transfer_rules": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Squad update model with intelligent routing support.
Required string length:
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(round_robin|load_balanced|skill_based|sentiment_based|context_aware)$Pattern:
^(active|inactive|archived)$Response
Successful Response
Squad response model.
⌘I
Update Squad
curl --request PUT \
--url https://api.example.com/squads/{squad_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"members": [
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"role": "<string>",
"specialization": "<string>",
"skills": [
"<string>"
],
"priority": 1,
"max_concurrent": 123,
"working_hours": {}
}
],
"transfer_rules": [
{
"to_member": "<string>",
"conditions": [
"<string>"
],
"from_member": "<string>",
"priority": 1,
"transfer_type": "warm",
"context_fields": [
"<string>"
]
}
],
"routing_strategy": "<string>",
"status": "<string>",
"default_member": "<string>",
"agents": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.example.com/squads/{squad_id}"
payload = {
"name": "<string>",
"description": "<string>",
"members": [
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"role": "<string>",
"specialization": "<string>",
"skills": ["<string>"],
"priority": 1,
"max_concurrent": 123,
"working_hours": {}
}
],
"transfer_rules": [
{
"to_member": "<string>",
"conditions": ["<string>"],
"from_member": "<string>",
"priority": 1,
"transfer_type": "warm",
"context_fields": ["<string>"]
}
],
"routing_strategy": "<string>",
"status": "<string>",
"default_member": "<string>",
"agents": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
members: [
{
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
role: '<string>',
specialization: '<string>',
skills: ['<string>'],
priority: 1,
max_concurrent: 123,
working_hours: {}
}
],
transfer_rules: [
{
to_member: '<string>',
conditions: ['<string>'],
from_member: '<string>',
priority: 1,
transfer_type: 'warm',
context_fields: ['<string>']
}
],
routing_strategy: '<string>',
status: '<string>',
default_member: '<string>',
agents: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.example.com/squads/{squad_id}', 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://api.example.com/squads/{squad_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'members' => [
[
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'role' => '<string>',
'specialization' => '<string>',
'skills' => [
'<string>'
],
'priority' => 1,
'max_concurrent' => 123,
'working_hours' => [
]
]
],
'transfer_rules' => [
[
'to_member' => '<string>',
'conditions' => [
'<string>'
],
'from_member' => '<string>',
'priority' => 1,
'transfer_type' => 'warm',
'context_fields' => [
'<string>'
]
]
],
'routing_strategy' => '<string>',
'status' => '<string>',
'default_member' => '<string>',
'agents' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/squads/{squad_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/squads/{squad_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/squads/{squad_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"members\": [\n {\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"specialization\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"priority\": 1,\n \"max_concurrent\": 123,\n \"working_hours\": {}\n }\n ],\n \"transfer_rules\": [\n {\n \"to_member\": \"<string>\",\n \"conditions\": [\n \"<string>\"\n ],\n \"from_member\": \"<string>\",\n \"priority\": 1,\n \"transfer_type\": \"warm\",\n \"context_fields\": [\n \"<string>\"\n ]\n }\n ],\n \"routing_strategy\": \"<string>\",\n \"status\": \"<string>\",\n \"default_member\": \"<string>\",\n \"agents\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"agents": [
{}
],
"routing_strategy": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"transfer_rules": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}