Skip to main content
POST
/
action
/
update_chat_properties
Update chat properties
curl --request POST \
  --url https://api.livechatinc.com/v3.6/agent/action/update_chat_properties \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "Q1VZR7AJCE",
  "properties": {
    "0805e283233042b37f460ed8fbf22160": {
      "string_property": "Chat property value updated by Agent"
    }
  }
}
'
import requests

url = "https://api.livechatinc.com/v3.6/agent/action/update_chat_properties"

payload = {
"id": "Q1VZR7AJCE",
"properties": { "0805e283233042b37f460ed8fbf22160": { "string_property": "Chat property value updated by Agent" } }
}
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: 'Q1VZR7AJCE',
properties: {
'0805e283233042b37f460ed8fbf22160': {string_property: 'Chat property value updated by Agent'}
}
})
};

fetch('https://api.livechatinc.com/v3.6/agent/action/update_chat_properties', 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.6/agent/action/update_chat_properties",
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' => 'Q1VZR7AJCE',
'properties' => [
'0805e283233042b37f460ed8fbf22160' => [
'string_property' => 'Chat property value updated by Agent'
]
]
]),
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.6/agent/action/update_chat_properties"

payload := strings.NewReader("{\n \"id\": \"Q1VZR7AJCE\",\n \"properties\": {\n \"0805e283233042b37f460ed8fbf22160\": {\n \"string_property\": \"Chat property value updated by Agent\"\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.6/agent/action/update_chat_properties")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"Q1VZR7AJCE\",\n \"properties\": {\n \"0805e283233042b37f460ed8fbf22160\": {\n \"string_property\": \"Chat property value updated by Agent\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.livechatinc.com/v3.6/agent/action/update_chat_properties")

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\": \"Q1VZR7AJCE\",\n \"properties\": {\n \"0805e283233042b37f460ed8fbf22160\": {\n \"string_property\": \"Chat property value updated by Agent\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
Required scopes: or

Authorizations

Authorization
string
header
required

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
id
string
required

The ID of the chat to update properties for.

properties
object
required

Properties to set. Use the format {"<namespace>": {"<property_name>": <value>}}. See the storing custom data guide for details on the properties format.

Response

200

Chat properties updated.