> ## 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 Customer Chat RTM API v3.7.

## Update chat properties

**Specifics**

|                        |                                                                                       |
| ---------------------- | ------------------------------------------------------------------------------------- |
| **Action**             | `update_chat_properties`                                                              |
| **Web API equivalent** | [`update_chat_properties`](/api/customer-chat/v3.7/properties/update-chat-properties) |
| **Push message**       | `chat_properties_updated`                                                             |

**Request**

| Parameter    | Required | Type     | Notes                                                                                                             |
| ------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `id`         | Yes      | `string` | The ID of the chat to set properties for.                                                                         |
| `properties` | Yes      | `object` | The chat properties to set. Follow the general properties format and include namespace, property name, and value. |

No response payload.

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

```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`                                                              |
| **Web API equivalent** | [`delete_chat_properties`](/api/customer-chat/v3.7/properties/delete-chat-properties) |
| **Push message**       | `chat_properties_deleted`                                                             |

**Request**

| Parameter    | Required | Type     | Notes                                       |
| ------------ | -------- | -------- | ------------------------------------------- |
| `id`         | Yes      | `string` | The ID of the chat to delete properties of. |
| `properties` | Yes      | `object` | The chat properties to delete.              |

No response payload.

```json title="Request" theme={null}
{
  "action": "delete_chat_properties",
  "payload": {
    "id": "Q1GZ3FNAT9",
    "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`                                                                |
| **Web API equivalent** | [`update_thread_properties`](/api/customer-chat/v3.7/properties/update-thread-properties) |
| **Push message**       | `thread_properties_updated`                                                               |

**Request**

| Parameter    | Required | Type     | Notes                                                                                                               |
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| `chat_id`    | Yes      | `string` | The ID of the chat to set properties for.                                                                           |
| `thread_id`  | Yes      | `string` | The ID of the thread to set properties for.                                                                         |
| `properties` | Yes      | `object` | The thread properties to set. Follow the general properties format and include namespace, property name, and value. |

No response payload.

```json title="Request" theme={null}
{
  "action": "update_thread_properties",
  "payload": {
    "chat_id": "Q1GZ3FNAT9",
    "thread_id": "Q1GZ3FNAU9",
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "Thread property value updated by Customer"
      }
    }
  }
}
```

```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`                                                                |
| **Web API equivalent** | [`delete_thread_properties`](/api/customer-chat/v3.7/properties/delete-thread-properties) |
| **Push message**       | `thread_properties_deleted`                                                               |

**Request**

| Parameter    | Required | Type     | Notes                                         |
| ------------ | -------- | -------- | --------------------------------------------- |
| `chat_id`    | Yes      | `string` | The ID of the chat to delete properties of.   |
| `thread_id`  | Yes      | `string` | The ID of the thread to delete properties of. |
| `properties` | Yes      | `object` | Thread properties to delete.                  |

No response payload.

```json title="Request" theme={null}
{
  "action": "delete_thread_properties",
  "payload": {
    "chat_id": "Q1GZ3FNAT9",
    "thread_id": "Q1GZ3FNAU9",
    "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`                                                               |
| **Web API equivalent** | [`update_event_properties`](/api/customer-chat/v3.7/properties/update-event-properties) |
| **Push message**       | `event_properties_updated`                                                              |

**Request**

| Parameter    | Required | Type     | Notes                                                                                                              |
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| `chat_id`    | Yes      | `string` | The ID of the chat to set properties for.                                                                          |
| `thread_id`  | Yes      | `string` | The ID of the thread to set properties for.                                                                        |
| `event_id`   | Yes      | `string` | The ID of the event to set properties for.                                                                         |
| `properties` | Yes      | `object` | The event properties to set. Follow the general properties format and include namespace, property name, and value. |

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 Customer"
      }
    }
  }
}
```

```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`                                                               |
| **Web API equivalent** | [`delete_event_properties`](/api/customer-chat/v3.7/properties/delete-event-properties) |
| **Push message**       | `event_properties_deleted`                                                              |

**Request**

| Parameter    | Required | Type     | Notes                                         |
| ------------ | -------- | -------- | --------------------------------------------- |
| `chat_id`    | Yes      | `string` | The ID of the chat to delete properties of.   |
| `thread_id`  | Yes      | `string` | The ID of the thread to delete properties of. |
| `event_id`   | Yes      | `string` | The ID of the event to delete properties of.  |
| `properties` | Yes      | `object` | The event properties to delete.               |

No response payload.

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

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