curl --request PUT \
--url https://my.cloudtalk.io/api/agents/add.json \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"firstname": "<string>",
"lastname": "<string>",
"email": "jsmith@example.com",
"pass": "<string>",
"status_outbound": true,
"daily_price_limit": 100,
"extension": 5499,
"call_number_id": 2
}
'import requests
url = "https://my.cloudtalk.io/api/agents/add.json"
payload = {
"firstname": "<string>",
"lastname": "<string>",
"email": "jsmith@example.com",
"pass": "<string>",
"status_outbound": True,
"daily_price_limit": 100,
"extension": 5499,
"call_number_id": 2
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstname: '<string>',
lastname: '<string>',
email: 'jsmith@example.com',
pass: '<string>',
status_outbound: true,
daily_price_limit: 100,
extension: 5499,
call_number_id: 2
})
};
fetch('https://my.cloudtalk.io/api/agents/add.json', 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://my.cloudtalk.io/api/agents/add.json",
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([
'firstname' => '<string>',
'lastname' => '<string>',
'email' => 'jsmith@example.com',
'pass' => '<string>',
'status_outbound' => true,
'daily_price_limit' => 100,
'extension' => 5499,
'call_number_id' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://my.cloudtalk.io/api/agents/add.json"
payload := strings.NewReader("{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://my.cloudtalk.io/api/agents/add.json")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://my.cloudtalk.io/api/agents/add.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}"
response = http.request(request)
puts response.read_body{
"responseData": {
"status": 201,
"data": {
"id": "12345"
}
}
}{
"responseData": {
"status": 403,
"message": "Max. number of agents reached."
}
}{
"responseData": {
"status": 406,
"message": "Invalid input data.",
"data": {
"email": [
"Please supply a valid email address."
]
}
}
}{
"responseData": {
"status": 500,
"message": "Something went wrong."
}
}Add an agent
Creates an agent. firstname, lastname, email and pass are required. The optional fields allow outbound calling (status_outbound), cap daily call spend in EUR (daily_price_limit, 1–200), assign a four-digit extension that must be unique across the company (1000–9999), and set a default outbound number (call_number_id). Returns 201 with the new agent’s ID; 403 means the account has reached its maximum number of agents.
Note the core API creates with PUT, not POST.
curl --request PUT \
--url https://my.cloudtalk.io/api/agents/add.json \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"firstname": "<string>",
"lastname": "<string>",
"email": "jsmith@example.com",
"pass": "<string>",
"status_outbound": true,
"daily_price_limit": 100,
"extension": 5499,
"call_number_id": 2
}
'import requests
url = "https://my.cloudtalk.io/api/agents/add.json"
payload = {
"firstname": "<string>",
"lastname": "<string>",
"email": "jsmith@example.com",
"pass": "<string>",
"status_outbound": True,
"daily_price_limit": 100,
"extension": 5499,
"call_number_id": 2
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstname: '<string>',
lastname: '<string>',
email: 'jsmith@example.com',
pass: '<string>',
status_outbound: true,
daily_price_limit: 100,
extension: 5499,
call_number_id: 2
})
};
fetch('https://my.cloudtalk.io/api/agents/add.json', 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://my.cloudtalk.io/api/agents/add.json",
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([
'firstname' => '<string>',
'lastname' => '<string>',
'email' => 'jsmith@example.com',
'pass' => '<string>',
'status_outbound' => true,
'daily_price_limit' => 100,
'extension' => 5499,
'call_number_id' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://my.cloudtalk.io/api/agents/add.json"
payload := strings.NewReader("{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://my.cloudtalk.io/api/agents/add.json")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://my.cloudtalk.io/api/agents/add.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"pass\": \"<string>\",\n \"status_outbound\": true,\n \"daily_price_limit\": 100,\n \"extension\": 5499,\n \"call_number_id\": 2\n}"
response = http.request(request)
puts response.read_body{
"responseData": {
"status": 201,
"data": {
"id": "12345"
}
}
}{
"responseData": {
"status": 403,
"message": "Max. number of agents reached."
}
}{
"responseData": {
"status": 406,
"message": "Invalid input data.",
"data": {
"email": [
"Please supply a valid email address."
]
}
}
}{
"responseData": {
"status": 500,
"message": "Something went wrong."
}
}Authorizations
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Body
First name
Last name
Password
Does agent have outbound calls allowed?
Daily price limit for all calls in EUR. Usually allowed values are from 1 to 200 EUR. Leave empty for using default value.
1 <= x <= 200Extension of an agent. Extension must be four digits long and be unique across whole company.
1000 <= x <= 9999Default outbound number ID
x >= 1Response
No error
Show child attributes
Show child attributes