Update chat properties
Specifics| Action | update_chat_properties |
| Required scopes | or |
| Push message | chat_properties_updated |
| Parameter | Required | Type | Notes |
|---|---|---|---|
id | Yes | string | The ID of the chat you want to set a property for. |
properties | Yes | object | The chat properties to set. Follow the general properties format and include namespace, property name, and value. |
Request
{
"action": "update_chat_properties",
"payload": {
"id": "Q1VZR7AJCE",
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "Chat property value updated by Agent"
}
}
}
}
Response
{
"request_id": "<request_id>",
"action": "update_chat_properties",
"type": "response",
"success": true,
"payload": {}
}
Delete chat properties
Specifics| Action | delete_chat_properties |
| Required scopes | or |
| Push message | chat_properties_deleted |
| Parameter | Required | Type | Notes |
|---|---|---|---|
id | Yes | string | The ID of the chat you want to delete a property for. |
properties | Yes | object | The chat properties to delete. |
Request
{
"action": "delete_chat_properties",
"payload": {
"id": "Q1VZR7AJCE",
"properties": {
"0805e283233042b37f460ed8fbf22160": ["string_property"]
}
}
}
Response
{
"request_id": "<request_id>",
"action": "delete_chat_properties",
"type": "response",
"success": true,
"payload": {}
}
Update thread properties
Specifics| Action | update_thread_properties |
| Required scopes | or |
| Push message | thread_properties_updated |
| Parameter | Required | Type | Notes |
|---|---|---|---|
chat_id | Yes | string | The ID of the chat you want to set properties for. |
thread_id | Yes | string | The ID of the thread you want to set properties for. |
properties | Yes | object | The thread properties to set. Follow the general properties format and include namespace, property name, and value. |
Request
{
"action": "update_thread_properties",
"payload": {
"chat_id": "Q1WZ073OA7",
"thread_id": "Q1WZ073OB7",
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "Chat thread property value updated by Agent"
}
}
}
}
Response
{
"request_id": "<request_id>",
"action": "update_thread_properties",
"type": "response",
"success": true,
"payload": {}
}
Delete thread properties
Specifics| Action | delete_thread_properties |
| Required scopes | or |
| Push message | thread_properties_deleted |
| Parameter | Required | Type | Notes |
|---|---|---|---|
chat_id | Yes | string | The ID of the chat you want to delete a property for. |
thread_id | Yes | string | The ID of the thread you want to delete a property for. |
properties | Yes | object | The thread properties to delete. |
Request
{
"action": "delete_thread_properties",
"payload": {
"chat_id": "Q1WZ073OA7",
"thread_id": "Q1WZ073OB7",
"properties": {
"0805e283233042b37f460ed8fbf22160": ["string_property"]
}
}
}
Response
{
"request_id": "<request_id>",
"action": "delete_thread_properties",
"type": "response",
"success": true,
"payload": {}
}
Update event properties
Specifics| Action | update_event_properties |
| Required scopes | or |
| Push message | event_properties_updated |
| Parameter | Required | Type | Notes |
|---|---|---|---|
chat_id | Yes | string | The ID of the chat you want to set properties for. |
thread_id | Yes | string | The ID of the thread you want to set properties for. |
event_id | Yes | string | The ID of the event you want to set properties for. |
properties | Yes | object | The event properties to set. |
Request
{
"action": "update_event_properties",
"payload": {
"chat_id": "Q1GZ3FNAT9",
"thread_id": "Q1GZ3FNAU9",
"event_id": "Q1GZ3FNAU9_1",
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "Event property value updated by Agent"
}
}
}
}
Response
{
"request_id": "<request_id>",
"action": "update_event_properties",
"type": "response",
"success": true,
"payload": {}
}
Delete event properties
Specifics| Action | delete_event_properties |
| Required scopes | or |
| Push message | event_properties_deleted |
| Parameter | Required | Type | Notes |
|---|---|---|---|
chat_id | Yes | string | The ID of the chat you want to delete the properties of. |
thread_id | Yes | string | The ID of the thread you want to delete the properties of. |
event_id | Yes | string | The ID of the event you want to delete the properties of. |
properties | Yes | object | The event properties to delete. Follow the general properties format and include namespace, property name, and value. |
Request
{
"action": "delete_event_properties",
"payload": {
"chat_id": "Q16ZSBGX3J",
"thread_id": "Q16ZSBGX4J",
"event_id": "Q16ZSBGX4J_1",
"properties": {
"0805e283233042b37f460ed8fbf22160": ["string_property"]
}
}
}
Response
{
"request_id": "<request_id>",
"action": "delete_event_properties",
"type": "response",
"success": true,
"payload": {}
}