Create agent
curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/create_agent \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "smith@example.com",
"name": "Agent Smith",
"role": "viceowner",
"groups": [
{
"id": 5,
"priority": "first"
},
{
"id": 2,
"priority": "last"
},
{
"id": 1,
"priority": "normal"
}
],
"work_scheduler": {
"schedule": [
{
"day": "monday",
"start": "08:00",
"end": "12:30",
"enabled": true
},
{
"day": "monday",
"start": "13:30",
"end": "16:00",
"enabled": true
},
{
"day": "friday",
"start": "08:00",
"end": "16:00",
"enabled": true
}
],
"timezone": "Europe/Warsaw"
},
"notifications": [
"new_visitor",
"new_goal",
"visitor_is_typing"
],
"email_subscriptions": [
"weekly_summary"
]
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/create_agent"
payload = {
"id": "smith@example.com",
"name": "Agent Smith",
"role": "viceowner",
"groups": [
{
"id": 5,
"priority": "first"
},
{
"id": 2,
"priority": "last"
},
{
"id": 1,
"priority": "normal"
}
],
"work_scheduler": {
"schedule": [
{
"day": "monday",
"start": "08:00",
"end": "12:30",
"enabled": True
},
{
"day": "monday",
"start": "13:30",
"end": "16:00",
"enabled": True
},
{
"day": "friday",
"start": "08:00",
"end": "16:00",
"enabled": True
}
],
"timezone": "Europe/Warsaw"
},
"notifications": ["new_visitor", "new_goal", "visitor_is_typing"],
"email_subscriptions": ["weekly_summary"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'smith@example.com',
name: 'Agent Smith',
role: 'viceowner',
groups: [
{id: 5, priority: 'first'},
{id: 2, priority: 'last'},
{id: 1, priority: 'normal'}
],
work_scheduler: {
schedule: [
{day: 'monday', start: '08:00', end: '12:30', enabled: true},
{day: 'monday', start: '13:30', end: '16:00', enabled: true},
{day: 'friday', start: '08:00', end: '16:00', enabled: true}
],
timezone: 'Europe/Warsaw'
},
notifications: ['new_visitor', 'new_goal', 'visitor_is_typing'],
email_subscriptions: ['weekly_summary']
})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/create_agent', 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.livechatinc.com/v3.5/configuration/action/create_agent",
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([
'id' => 'smith@example.com',
'name' => 'Agent Smith',
'role' => 'viceowner',
'groups' => [
[
'id' => 5,
'priority' => 'first'
],
[
'id' => 2,
'priority' => 'last'
],
[
'id' => 1,
'priority' => 'normal'
]
],
'work_scheduler' => [
'schedule' => [
[
'day' => 'monday',
'start' => '08:00',
'end' => '12:30',
'enabled' => true
],
[
'day' => 'monday',
'start' => '13:30',
'end' => '16:00',
'enabled' => true
],
[
'day' => 'friday',
'start' => '08:00',
'end' => '16:00',
'enabled' => true
]
],
'timezone' => 'Europe/Warsaw'
],
'notifications' => [
'new_visitor',
'new_goal',
'visitor_is_typing'
],
'email_subscriptions' => [
'weekly_summary'
]
]),
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://api.livechatinc.com/v3.5/configuration/action/create_agent"
payload := strings.NewReader("{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.livechatinc.com/v3.5/configuration/action/create_agent")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/create_agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "smith@example.com"
}Agents
Create agent
Creates a new agent with specified parameters within a license. Can be sent in batch.
POST
/
action
/
create_agent
Create agent
curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/create_agent \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "smith@example.com",
"name": "Agent Smith",
"role": "viceowner",
"groups": [
{
"id": 5,
"priority": "first"
},
{
"id": 2,
"priority": "last"
},
{
"id": 1,
"priority": "normal"
}
],
"work_scheduler": {
"schedule": [
{
"day": "monday",
"start": "08:00",
"end": "12:30",
"enabled": true
},
{
"day": "monday",
"start": "13:30",
"end": "16:00",
"enabled": true
},
{
"day": "friday",
"start": "08:00",
"end": "16:00",
"enabled": true
}
],
"timezone": "Europe/Warsaw"
},
"notifications": [
"new_visitor",
"new_goal",
"visitor_is_typing"
],
"email_subscriptions": [
"weekly_summary"
]
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/create_agent"
payload = {
"id": "smith@example.com",
"name": "Agent Smith",
"role": "viceowner",
"groups": [
{
"id": 5,
"priority": "first"
},
{
"id": 2,
"priority": "last"
},
{
"id": 1,
"priority": "normal"
}
],
"work_scheduler": {
"schedule": [
{
"day": "monday",
"start": "08:00",
"end": "12:30",
"enabled": True
},
{
"day": "monday",
"start": "13:30",
"end": "16:00",
"enabled": True
},
{
"day": "friday",
"start": "08:00",
"end": "16:00",
"enabled": True
}
],
"timezone": "Europe/Warsaw"
},
"notifications": ["new_visitor", "new_goal", "visitor_is_typing"],
"email_subscriptions": ["weekly_summary"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'smith@example.com',
name: 'Agent Smith',
role: 'viceowner',
groups: [
{id: 5, priority: 'first'},
{id: 2, priority: 'last'},
{id: 1, priority: 'normal'}
],
work_scheduler: {
schedule: [
{day: 'monday', start: '08:00', end: '12:30', enabled: true},
{day: 'monday', start: '13:30', end: '16:00', enabled: true},
{day: 'friday', start: '08:00', end: '16:00', enabled: true}
],
timezone: 'Europe/Warsaw'
},
notifications: ['new_visitor', 'new_goal', 'visitor_is_typing'],
email_subscriptions: ['weekly_summary']
})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/create_agent', 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.livechatinc.com/v3.5/configuration/action/create_agent",
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([
'id' => 'smith@example.com',
'name' => 'Agent Smith',
'role' => 'viceowner',
'groups' => [
[
'id' => 5,
'priority' => 'first'
],
[
'id' => 2,
'priority' => 'last'
],
[
'id' => 1,
'priority' => 'normal'
]
],
'work_scheduler' => [
'schedule' => [
[
'day' => 'monday',
'start' => '08:00',
'end' => '12:30',
'enabled' => true
],
[
'day' => 'monday',
'start' => '13:30',
'end' => '16:00',
'enabled' => true
],
[
'day' => 'friday',
'start' => '08:00',
'end' => '16:00',
'enabled' => true
]
],
'timezone' => 'Europe/Warsaw'
],
'notifications' => [
'new_visitor',
'new_goal',
'visitor_is_typing'
],
'email_subscriptions' => [
'weekly_summary'
]
]),
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://api.livechatinc.com/v3.5/configuration/action/create_agent"
payload := strings.NewReader("{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.livechatinc.com/v3.5/configuration/action/create_agent")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/create_agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"smith@example.com\",\n \"name\": \"Agent Smith\",\n \"role\": \"viceowner\",\n \"groups\": [\n {\n \"id\": 5,\n \"priority\": \"first\"\n },\n {\n \"id\": 2,\n \"priority\": \"last\"\n },\n {\n \"id\": 1,\n \"priority\": \"normal\"\n }\n ],\n \"work_scheduler\": {\n \"schedule\": [\n {\n \"day\": \"monday\",\n \"start\": \"08:00\",\n \"end\": \"12:30\",\n \"enabled\": true\n },\n {\n \"day\": \"monday\",\n \"start\": \"13:30\",\n \"end\": \"16:00\",\n \"enabled\": true\n },\n {\n \"day\": \"friday\",\n \"start\": \"08:00\",\n \"end\": \"16:00\",\n \"enabled\": true\n }\n ],\n \"timezone\": \"Europe/Warsaw\"\n },\n \"notifications\": [\n \"new_visitor\",\n \"new_goal\",\n \"visitor_is_typing\"\n ],\n \"email_subscriptions\": [\n \"weekly_summary\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "smith@example.com"
}Required scopes:
accounts--all:rc, Authorizations
PersonalAccessTokenOAuth2BearerToken
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
application/json
The agent ID.
The agent name.
The agent role.
Available options:
viceowner, administrator, normal The agent's default status right after login.
Available options:
accepting chats, not accepting chats The agent's job title.
The agent's mobile number.
The agent's maximum number of concurrent chats.
Required range:
x <= 20If set to true: the agent will be awaiting approval after creation. Only a requester with the subscription.lc:rw scope can set this value to false.
Groups the agent belongs to.
Show child attributes
Show child attributes
Agent notifications that are turned on.
Available options:
new_visitor, incoming_chat, returning_visitor, queued_visitor, visitor_is_typing, new_goal, unassigned_chats, unassigned_chat_messages, ticket, inactive_notifications, mute_all_sounds, repeat_sound_notifications, ticket_notifications, incoming_message_for_focused_chat Subscriptions that will be sent to the agent via email.
Available options:
daily_summary, weekly_summary The work scheduler options to set for the new agent.
Show child attributes
Show child attributes
Response
200 - application/json
Agent created successfully.
Unique identifier of the created agent.
Was this page helpful?
⌘I