> ## Documentation Index
> Fetch the complete documentation index at: https://www.text.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Properties

> Reference of Properties methods for the Agent Chat RTM API v3.5.

## Update chat properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Action**          | `update_chat_properties`                                                                                                                                                                                                                                                                                                             |
| **Required scopes** | <Tooltip tip="To update properties in a chat taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To update properties in a chat taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `chat_properties_updated`                                                                                                                                                                                                                                                                                                            |

**Request**

| 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](/api/configuration/v3.5/) and include namespace, property name, and value. |

No response payload.

```json title="Request" theme={null}
{
  "action": "update_chat_properties",
  "payload": {
    "id": "Q1VZR7AJCE",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "Chat property value updated by Agent"
      }
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "update_chat_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```

***

## Delete chat properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Action**          | `delete_chat_properties`                                                                                                                                                                                                                                                                                                             |
| **Required scopes** | <Tooltip tip="To delete properties in a chat taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To delete properties in a chat taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `chat_properties_deleted`                                                                                                                                                                                                                                                                                                            |

**Request**

| 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.                        |

No response payload.

```json title="Request" theme={null}
{
  "action": "delete_chat_properties",
  "payload": {
    "id": "Q1VZR7AJCE",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": ["string_property"]
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "delete_chat_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```

***

## Update thread properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Action**          | `update_thread_properties`                                                                                                                                                                                                                                                                                                               |
| **Required scopes** | <Tooltip tip="To update properties in a thread taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To update properties in a thread taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `thread_properties_updated`                                                                                                                                                                                                                                                                                                              |

**Request**

| 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](/api/configuration/v3.5/) and include namespace, property name, and value. |

No response payload.

```json title="Request" theme={null}
{
  "action": "update_thread_properties",
  "payload": {
    "chat_id": "Q1WZ073OA7",
    "thread_id": "Q1WZ073OB7",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "Chat thread property value updated by Agent"
      }
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "update_thread_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```

***

## Delete thread properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Action**          | `delete_thread_properties`                                                                                                                                                                                                                                                                                                               |
| **Required scopes** | <Tooltip tip="To delete properties in a thread taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To delete properties in a thread taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `thread_properties_deleted`                                                                                                                                                                                                                                                                                                              |

**Request**

| 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.                        |

No response payload.

```json title="Request" theme={null}
{
  "action": "delete_thread_properties",
  "payload": {
    "chat_id": "Q1WZ073OA7",
    "thread_id": "Q1WZ073OB7",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": ["string_property"]
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "delete_thread_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```

***

## Update event properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Action**          | `update_event_properties`                                                                                                                                                                                                                                                                                                                |
| **Required scopes** | <Tooltip tip="To update properties in an event taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To update properties in an event taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `event_properties_updated`                                                                                                                                                                                                                                                                                                               |

**Request**

| 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.                         |

No response payload.

```json title="Request" theme={null}
{
  "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"
      }
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "update_event_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```

***

## Delete event properties

**Specifics**

|                     |                                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Action**          | `delete_event_properties`                                                                                                                                                                                                                                                                                                                |
| **Required scopes** | <Tooltip tip="To delete properties in an event taking place in any group.">`chats--all:rw`</Tooltip> or <Tooltip tip="To delete properties in an event taking place in groups that the requester is a member of. The agent groups and the chat groups must overlap — at least one group must be in common.">`chats--access:rw`</Tooltip> |
| **Push message**    | `event_properties_deleted`                                                                                                                                                                                                                                                                                                               |

**Request**

| 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](/api/configuration/v3.5/) and include namespace, property name, and value. |

No response payload.

```json title="Request" theme={null}
{
  "action": "delete_event_properties",
  "payload": {
    "chat_id": "Q16ZSBGX3J",
    "thread_id": "Q16ZSBGX4J",
    "event_id": "Q16ZSBGX4J_1",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": ["string_property"]
    }
  }
}
```

```json title="Response" theme={null}
{
  "request_id": "<request_id>",
  "action": "delete_event_properties",
  "type": "response",
  "success": true,
  "payload": {}
}
```