curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/register_property \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "string_property",
"owner_client_id": "0805e283233042b37f460ed8fbf22160",
"type": "string",
"default_value": "string_default_value",
"access": {
"chat": {
"agent": [
"read"
],
"customer": [
"read",
"write"
]
}
}
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/register_property"
payload = {
"name": "string_property",
"owner_client_id": "0805e283233042b37f460ed8fbf22160",
"type": "string",
"default_value": "string_default_value",
"access": { "chat": {
"agent": ["read"],
"customer": ["read", "write"]
} }
}
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({
name: 'string_property',
owner_client_id: '0805e283233042b37f460ed8fbf22160',
type: 'string',
default_value: 'string_default_value',
access: {chat: {agent: ['read'], customer: ['read', 'write']}}
})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/register_property', 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/register_property",
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_property',
'owner_client_id' => '0805e283233042b37f460ed8fbf22160',
'type' => 'string',
'default_value' => 'string_default_value',
'access' => [
'chat' => [
'agent' => [
'read'
],
'customer' => [
'read',
'write'
]
]
]
]),
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/register_property"
payload := strings.NewReader("{\n \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\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/register_property")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/register_property")
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 \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_bodyRegister property
Registers a new private property for a given Client Id.
curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/register_property \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "string_property",
"owner_client_id": "0805e283233042b37f460ed8fbf22160",
"type": "string",
"default_value": "string_default_value",
"access": {
"chat": {
"agent": [
"read"
],
"customer": [
"read",
"write"
]
}
}
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/register_property"
payload = {
"name": "string_property",
"owner_client_id": "0805e283233042b37f460ed8fbf22160",
"type": "string",
"default_value": "string_default_value",
"access": { "chat": {
"agent": ["read"],
"customer": ["read", "write"]
} }
}
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({
name: 'string_property',
owner_client_id: '0805e283233042b37f460ed8fbf22160',
type: 'string',
default_value: 'string_default_value',
access: {chat: {agent: ['read'], customer: ['read', 'write']}}
})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/register_property', 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/register_property",
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_property',
'owner_client_id' => '0805e283233042b37f460ed8fbf22160',
'type' => 'string',
'default_value' => 'string_default_value',
'access' => [
'chat' => [
'agent' => [
'read'
],
'customer' => [
'read',
'write'
]
]
]
]),
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/register_property"
payload := strings.NewReader("{\n \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\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/register_property")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/register_property")
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 \"name\": \"string_property\",\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\",\n \"type\": \"string\",\n \"default_value\": \"string_default_value\",\n \"access\": {\n \"chat\": {\n \"agent\": [\n \"read\"\n ],\n \"customer\": [\n \"read\",\n \"write\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_bodyproperties.configuration:rwAuthorizations
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
The property name.
The Client Id that will own the property. Must be owned by your organization.
The property type.
int, string, bool, tokenized_string An object with location keys (chat, thread, event, license, group) and their access configuration.
Show child attributes
Show child attributes
The property description.
An array of values that the property can be set to. Only one of domain and range can be set for a single property.
A range of values that the property can be set to. Works only for numeric types.
Show child attributes
Show child attributes
The default value of the property. Validated by domain or range, if one exists. Registering a property with default_value is possible only if access.<location> is set to license or to group.
Response
Property registered successfully.
Was this page helpful?