Create Live Agent
curl --request POST \
--url 'https://api.example.com/api/v1/user/create_live_agent?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"is_active": true,
"is_superuser": false,
"birthdate": "2023-11-07T05:31:56Z",
"is_enterprise": false,
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"state": "<string>",
"country": "<string>",
"address": "<string>",
"active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripe_customer_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_subscription_status": "<string>",
"stripe_has_payment_method": false,
"is_trial": false,
"used_trial": false,
"is_paying": false,
"stripe_last_payment_date": "2023-11-07T05:31:56Z",
"billing_updated_at": "2023-11-07T05:31:56Z",
"last_credits_refresh": "2023-11-07T05:31:56Z",
"next_credits_refresh": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.example.com/api/v1/user/create_live_agent?api_key="
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"is_active": True,
"is_superuser": False,
"birthdate": "2023-11-07T05:31:56Z",
"is_enterprise": False,
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"state": "<string>",
"country": "<string>",
"address": "<string>",
"active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripe_customer_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_subscription_status": "<string>",
"stripe_has_payment_method": False,
"is_trial": False,
"used_trial": False,
"is_paying": False,
"stripe_last_payment_date": "2023-11-07T05:31:56Z",
"billing_updated_at": "2023-11-07T05:31:56Z",
"last_credits_refresh": "2023-11-07T05:31:56Z",
"next_credits_refresh": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
is_active: true,
is_superuser: false,
birthdate: '2023-11-07T05:31:56Z',
is_enterprise: false,
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phone: '<string>',
state: '<string>',
country: '<string>',
address: '<string>',
active_billing_plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
next_billing_plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stripe_customer_id: '<string>',
stripe_subscription_id: '<string>',
stripe_subscription_status: '<string>',
stripe_has_payment_method: false,
is_trial: false,
used_trial: false,
is_paying: false,
stripe_last_payment_date: '2023-11-07T05:31:56Z',
billing_updated_at: '2023-11-07T05:31:56Z',
last_credits_refresh: '2023-11-07T05:31:56Z',
next_credits_refresh: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.example.com/api/v1/user/create_live_agent?api_key=', 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/api/v1/user/create_live_agent?api_key=",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'is_active' => true,
'is_superuser' => false,
'birthdate' => '2023-11-07T05:31:56Z',
'is_enterprise' => false,
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phone' => '<string>',
'state' => '<string>',
'country' => '<string>',
'address' => '<string>',
'active_billing_plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'next_billing_plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stripe_customer_id' => '<string>',
'stripe_subscription_id' => '<string>',
'stripe_subscription_status' => '<string>',
'stripe_has_payment_method' => false,
'is_trial' => false,
'used_trial' => false,
'is_paying' => false,
'stripe_last_payment_date' => '2023-11-07T05:31:56Z',
'billing_updated_at' => '2023-11-07T05:31:56Z',
'last_credits_refresh' => '2023-11-07T05:31:56Z',
'next_credits_refresh' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"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/api/v1/user/create_live_agent?api_key="
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/user/create_live_agent?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/user/create_live_agent?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": null
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}User
Create Live Agent
Creates a new user with role agent
Required roles:
- admin
POST
/
api
/
v1
/
user
/
create_live_agent
Create Live Agent
curl --request POST \
--url 'https://api.example.com/api/v1/user/create_live_agent?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"is_active": true,
"is_superuser": false,
"birthdate": "2023-11-07T05:31:56Z",
"is_enterprise": false,
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"state": "<string>",
"country": "<string>",
"address": "<string>",
"active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripe_customer_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_subscription_status": "<string>",
"stripe_has_payment_method": false,
"is_trial": false,
"used_trial": false,
"is_paying": false,
"stripe_last_payment_date": "2023-11-07T05:31:56Z",
"billing_updated_at": "2023-11-07T05:31:56Z",
"last_credits_refresh": "2023-11-07T05:31:56Z",
"next_credits_refresh": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.example.com/api/v1/user/create_live_agent?api_key="
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"is_active": True,
"is_superuser": False,
"birthdate": "2023-11-07T05:31:56Z",
"is_enterprise": False,
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "<string>",
"state": "<string>",
"country": "<string>",
"address": "<string>",
"active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripe_customer_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_subscription_status": "<string>",
"stripe_has_payment_method": False,
"is_trial": False,
"used_trial": False,
"is_paying": False,
"stripe_last_payment_date": "2023-11-07T05:31:56Z",
"billing_updated_at": "2023-11-07T05:31:56Z",
"last_credits_refresh": "2023-11-07T05:31:56Z",
"next_credits_refresh": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
is_active: true,
is_superuser: false,
birthdate: '2023-11-07T05:31:56Z',
is_enterprise: false,
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phone: '<string>',
state: '<string>',
country: '<string>',
address: '<string>',
active_billing_plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
next_billing_plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stripe_customer_id: '<string>',
stripe_subscription_id: '<string>',
stripe_subscription_status: '<string>',
stripe_has_payment_method: false,
is_trial: false,
used_trial: false,
is_paying: false,
stripe_last_payment_date: '2023-11-07T05:31:56Z',
billing_updated_at: '2023-11-07T05:31:56Z',
last_credits_refresh: '2023-11-07T05:31:56Z',
next_credits_refresh: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.example.com/api/v1/user/create_live_agent?api_key=', 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/api/v1/user/create_live_agent?api_key=",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'is_active' => true,
'is_superuser' => false,
'birthdate' => '2023-11-07T05:31:56Z',
'is_enterprise' => false,
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phone' => '<string>',
'state' => '<string>',
'country' => '<string>',
'address' => '<string>',
'active_billing_plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'next_billing_plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stripe_customer_id' => '<string>',
'stripe_subscription_id' => '<string>',
'stripe_subscription_status' => '<string>',
'stripe_has_payment_method' => false,
'is_trial' => false,
'used_trial' => false,
'is_paying' => false,
'stripe_last_payment_date' => '2023-11-07T05:31:56Z',
'billing_updated_at' => '2023-11-07T05:31:56Z',
'last_credits_refresh' => '2023-11-07T05:31:56Z',
'next_credits_refresh' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"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/api/v1/user/create_live_agent?api_key="
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/user/create_live_agent?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/user/create_live_agent?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"birthdate\": \"2023-11-07T05:31:56Z\",\n \"is_enterprise\": false,\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": \"<string>\",\n \"active_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"next_billing_plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stripe_customer_id\": \"<string>\",\n \"stripe_subscription_id\": \"<string>\",\n \"stripe_subscription_status\": \"<string>\",\n \"stripe_has_payment_method\": false,\n \"is_trial\": false,\n \"used_trial\": false,\n \"is_paying\": false,\n \"stripe_last_payment_date\": \"2023-11-07T05:31:56Z\",\n \"billing_updated_at\": \"2023-11-07T05:31:56Z\",\n \"last_credits_refresh\": \"2023-11-07T05:31:56Z\",\n \"next_credits_refresh\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": null
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your API KeyHTTPBearer
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.
Body
application/json
Was this page helpful?