curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"agent": {
"email": "jane@acme.com",
"name": "Jane Doe",
"role": "agent",
"availability": "offline",
"auto_offline": false,
"assignment_limit": 10
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents"
payload = { "agent": {
"email": "jane@acme.com",
"name": "Jane Doe",
"role": "agent",
"availability": "offline",
"auto_offline": False,
"assignment_limit": 10
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent: {
email: 'jane@acme.com',
name: 'Jane Doe',
role: 'agent',
availability: 'offline',
auto_offline: false,
assignment_limit: 10
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents",
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([
'agent' => [
'email' => 'jane@acme.com',
'name' => 'Jane Doe',
'role' => 'agent',
'availability' => 'offline',
'auto_offline' => false,
'assignment_limit' => 10
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents"
payload := strings.NewReader("{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 7,
"name": "Jane Doe",
"email": "jane@acme.com",
"role": "agent",
"availability_status": "online",
"auto_offline": true,
"assignment_limit": null,
"is_ai_agent": false,
"team_ids": [
5
],
"inbox_ids": [
3
],
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z",
"display_name": "<string>"
}{
"error": {
"code": "bad_request",
"message": "The request is malformed."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "limit_exceeded",
"message": "The account has reached its agent license limit. Purchase more licenses to add agents."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action."
}
}{
"error": {
"code": "not_found",
"message": "The requested resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "email",
"code": "taken",
"message": "has already been taken"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Create an agent
Administrator only. Invites the agent by email; someone who already has a CloudChat login on another account becomes a member of this one, keeping that login. Consumes one agent license seat — a 402 means the account has none left.
curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"agent": {
"email": "jane@acme.com",
"name": "Jane Doe",
"role": "agent",
"availability": "offline",
"auto_offline": false,
"assignment_limit": 10
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents"
payload = { "agent": {
"email": "jane@acme.com",
"name": "Jane Doe",
"role": "agent",
"availability": "offline",
"auto_offline": False,
"assignment_limit": 10
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent: {
email: 'jane@acme.com',
name: 'Jane Doe',
role: 'agent',
availability: 'offline',
auto_offline: false,
assignment_limit: 10
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents",
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([
'agent' => [
'email' => 'jane@acme.com',
'name' => 'Jane Doe',
'role' => 'agent',
'availability' => 'offline',
'auto_offline' => false,
'assignment_limit' => 10
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents"
payload := strings.NewReader("{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": {\n \"email\": \"jane@acme.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"agent\",\n \"availability\": \"offline\",\n \"auto_offline\": false,\n \"assignment_limit\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 7,
"name": "Jane Doe",
"email": "jane@acme.com",
"role": "agent",
"availability_status": "online",
"auto_offline": true,
"assignment_limit": null,
"is_ai_agent": false,
"team_ids": [
5
],
"inbox_ids": [
3
],
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z",
"display_name": "<string>"
}{
"error": {
"code": "bad_request",
"message": "The request is malformed."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "limit_exceeded",
"message": "The account has reached its agent license limit. Purchase more licenses to add agents."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action."
}
}{
"error": {
"code": "not_found",
"message": "The requested resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "email",
"code": "taken",
"message": "has already been taken"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Authorizations
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
Body
The agent goes under an agent wrapper. Administrator only.
Show child attributes
Show child attributes
Response
Created.
A human or AI agent of the account. A hidden admin — the platform's own support user — never appears here, on the list or by id.
7
"Jane Doe"
"jane@acme.com"
agent, administrator, supervisor, assistant, cx_engineer "agent"
online, offline, busy "online"
Whether the agent is moved to offline automatically after a period of inactivity.
true
Per-agent override of the account's default conversation assignment limit. null when the agent uses the account default.
null
false
Teams the agent belongs to, scoped to this account.
[5]
Inboxes the agent is a member of, scoped to this account.
[3]
"2026-05-02T11:04:17.000Z"
"2026-08-10T14:32:05.123Z"
The name that belongs to this account only, when there is one. It is what name shows; null means name comes from the user's global record.