Create new team
curl --request POST \
--url http://localhost:8080/teams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"is_support_enabled": true,
"support_office_hours_id": "<string>",
"call_wrap_up_seconds": 1800,
"telephony_pacing_enabled": true,
"telephony_ring_seconds": 65,
"telephony_queue_wait_seconds": 1815,
"auto_assign_interval_seconds": 1800
}
'import requests
url = "http://localhost:8080/teams"
payload = {
"name": "<string>",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"is_support_enabled": True,
"support_office_hours_id": "<string>",
"call_wrap_up_seconds": 1800,
"telephony_pacing_enabled": True,
"telephony_ring_seconds": 65,
"telephony_queue_wait_seconds": 1815,
"auto_assign_interval_seconds": 1800
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
is_support_enabled: true,
support_office_hours_id: '<string>',
call_wrap_up_seconds: 1800,
telephony_pacing_enabled: true,
telephony_ring_seconds: 65,
telephony_queue_wait_seconds: 1815,
auto_assign_interval_seconds: 1800
})
};
fetch('http://localhost:8080/teams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/teams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'is_support_enabled' => true,
'support_office_hours_id' => '<string>',
'call_wrap_up_seconds' => 1800,
'telephony_pacing_enabled' => true,
'telephony_ring_seconds' => 65,
'telephony_queue_wait_seconds' => 1815,
'auto_assign_interval_seconds' => 1800
]),
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 := "http://localhost:8080/teams"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:8080/teams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/teams")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Teams
Create new team
Create a new team in the organization. Use when syncing team structure between OpenCX and your organisation’s identity/HR source of truth.
POST
/
teams
Create new team
curl --request POST \
--url http://localhost:8080/teams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"is_support_enabled": true,
"support_office_hours_id": "<string>",
"call_wrap_up_seconds": 1800,
"telephony_pacing_enabled": true,
"telephony_ring_seconds": 65,
"telephony_queue_wait_seconds": 1815,
"auto_assign_interval_seconds": 1800
}
'import requests
url = "http://localhost:8080/teams"
payload = {
"name": "<string>",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"is_support_enabled": True,
"support_office_hours_id": "<string>",
"call_wrap_up_seconds": 1800,
"telephony_pacing_enabled": True,
"telephony_ring_seconds": 65,
"telephony_queue_wait_seconds": 1815,
"auto_assign_interval_seconds": 1800
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
is_support_enabled: true,
support_office_hours_id: '<string>',
call_wrap_up_seconds: 1800,
telephony_pacing_enabled: true,
telephony_ring_seconds: 65,
telephony_queue_wait_seconds: 1815,
auto_assign_interval_seconds: 1800
})
};
fetch('http://localhost:8080/teams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/teams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'is_support_enabled' => true,
'support_office_hours_id' => '<string>',
'call_wrap_up_seconds' => 1800,
'telephony_pacing_enabled' => true,
'telephony_ring_seconds' => 65,
'telephony_queue_wait_seconds' => 1815,
'auto_assign_interval_seconds' => 1800
]),
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 := "http://localhost:8080/teams"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:8080/teams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/teams")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"is_support_enabled\": true,\n \"support_office_hours_id\": \"<string>\",\n \"call_wrap_up_seconds\": 1800,\n \"telephony_pacing_enabled\": true,\n \"telephony_ring_seconds\": 65,\n \"telephony_queue_wait_seconds\": 1815,\n \"auto_assign_interval_seconds\": 1800\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Configure telephony pacing, distribution, and wrap-up with the optional team policy fields.
Optionally set
category_id to a category from the same workspace. See team categories for defaults, clearing a category, and validation.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
least-busy, round-robin, unassigned Team wrap-up in seconds. Null inherits the organization setting; zero disables wrap-up.
Required range:
0 <= x <= 3600Queue calls for this team and offer each call to one available agent at a time.
Required range:
10 <= x <= 120Required range:
30 <= x <= 3600Available options:
fewest_answered_today, longest_available Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600.
Required range:
0 <= x <= 3600Response
Default Response
Was this page helpful?