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

# Data structures

> Reference of data structures available in the Customer Chat API v3.6.

This document contains a reference of data structures available in the Customer Chat API. Here, you can review the object fields, as well as sample responses for the [event](#events), [user](#users), and [other common structures](#other-common-structures). The reference applies both to the **Web** and **RTM APIs**.

## Events

Events are sent to a chat through the `send_event` method and returned in chat and thread responses.

An event can include a `recipients` field that limits who it's visible to. Possible values are `all` and `agents`. The field is optional when sending an event. It's returned on events read from the archives, where messages are reported as `all`; it's not returned on events delivered through RTM pushes.

### File

The **File** event represents an uploaded file.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `file`.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

**url** `string` *required*

The file URL. It must point to the Text CDN. Use the URL returned by
[`upload_file`](https://www.text.com/docs/api/customer-chat/v3.6/events/upload-file).

**alternative\_text** `string`

The alternative text for the image.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string` *required*

The ID of the event author.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

**name** `string` *required*

The file name.

**url** `string` *required*

The file URL.

**thumbnail\_url, thumbnail2x\_url** `string`

The image thumbnail URLs.

**content\_type** `string` *required*

The file media type.

**size, width, height** `integer`

The file size and image dimensions.

**alternative\_text** `string`

The alternative text for the image.

```json Sample File in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "type": "file",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "name": "image25.png",
  "url": "https://example.com/image25.png",
  "thumbnail_url": "https://example.com/thumbnail.png",
  "thumbnail2x_url": "https://example.com/thumbnail2x.png",
  "content_type": "image/png",
  "size": 123444,
  "width": 640,
  "height": 480,
  "alternative_text": "A sample image"
}
```

### Form

The **Form** event contains an empty form to be sent in the chat. It doesn't matter how the form is configured or what fields it has — it can be any event of type `form`. Currently, the **Form** events are not supported natively in Text, but you can leverage this feature in a custom chatting solution.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `form`.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**form\_id** `string` *required*

The form ID.

**fields** `array` *required*

The fields in the form. See [Form fields](#form-fields).

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`, `group_chooser`, `name`, `phone`, `question`, `radio`, `select`, `subject`, `textarea`.

**fields.id** `string` *required*

The form field ID. The value must be unique within the form.

**fields.label** `string` *required*

The form field label.

**fields.required** `boolean`

Whether an answer to the field is required.

**fields.options** `array`

The selectable options for `checkbox`, `group_chooser`, `radio`, and `select` fields.

**fields.options properties**

**fields.options.id** `string` *required*

The option ID.

**fields.options.label** `string` *required*

The option label.

**fields.options.checked** `boolean`

If `true`, the option is selected by default.

**fields.groups** `array`

The groups available for a `group_chooser` field.

**fields.groups properties**

**fields.groups.id** `string` *required*

The group ID.

**fields.groups.label** `string` *required*

The group label.

**fields.groups.checked** `boolean`

If `true`, the group is selected by default.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string`

The ID of the event author. Omitted when the form is generated by the system.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**form\_id** `string` *required*

The form ID.

**form\_type** `string`

The form type. Common values include `prechat`, `postchat`, and `ask_for_email`. This field is absent from chats started before the field was introduced.

**fields** `array` *required*

The fields in the form. See [Form fields](#form-fields).

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`, `group_chooser`, `name`, `phone`, `question`, `radio`, `select`, `subject`, `textarea`.

**fields.id** `string` *required*

The form field ID. The value must be unique within the form.

**fields.label** `string` *required*

The form field label.

**fields.required** `boolean`

Whether an answer to the field is required.

**fields.options** `array`

The selectable options for `checkbox`, `group_chooser`, `radio`, and `select` fields.

**fields.options properties**

**fields.options.id** `string` *required*

The option ID.

**fields.options.label** `string` *required*

The option label.

**fields.options.checked** `boolean`

If `true`, the option is selected by default.

**fields.groups** `array`

The groups available for a `group_chooser` field.

**fields.groups properties**

**fields.groups.id** `string` *required*

The group ID.

**fields.groups.label** `string` *required*

The group label.

**fields.groups.checked** `boolean`

If `true`, the group is selected by default.

```json Sample Form in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "type": "form",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "form_id": "1473433500211",
  "form_type": "prechat",
  "fields": [
    {
      "type": "name",
      "id": "154417206262603539",
      "label": "Your name",
      "required": true
    },
    {
      "type": "email",
      "id": "154417206262601584",
      "label": "Your email",
      "required": false
    },
    {
      "type": "question",
      "id": "154417206262601585",
      "label": "What are you looking for?",
      "required": false
    },
    {
      "type": "textarea",
      "id": "154417206262601586",
      "label": "Additional info",
      "required": false
    },
    {
      "type": "radio",
      "id": "154417206262602571",
      "label": "Chat purpose",
      "required": false,
      "options": [
        {
          "id": "0",
          "label": "Support"
        }
      ]
    },
    {
      "type": "select",
      "id": "154417206262602572",
      "label": "Country",
      "required": false,
      "options": [
        {
          "id": "0",
          "label": "USA"
        },
        {
          "id": "1",
          "label": "UK"
        }
      ]
    },
    {
      "type": "checkbox",
      "id": "154417206262604640",
      "label": "Company industry",
      "required": false,
      "options": [
        {
          "id": "0",
          "label": "automotive"
        },
        {
          "id": "1",
          "label": "it"
        }
      ]
    },
    {
      "type": "group_chooser",
      "id": "154417206262605324",
      "label": "Choose department",
      "required": true,
      "options": [
        {
          "id": "2",
          "label": "Marketing"
        }
      ],
      "groups": [
        {
          "id": "1",
          "label": "Marketing"
        }
      ]
    }
  ]
}
```

### Filled form

The **Filled form** event contains data submitted through a prechat or postchat form.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `filled_form`.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**form\_id** `string` *required*

The form ID.

**fields** `array` *required*

The fields in the form. See [Filled form fields](#filled-form-fields).

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`, `group_chooser`, `name`, `phone`, `question`, `radio`, `select`, `subject`, `textarea`.

**fields.id** `string` *required*

The form field ID. The value must be unique within the form.

**fields.label** `string` *required*

The form field label.

**fields.answer** `any`

The answer to the form field.

**fields.answer properties**

**fields.answer.id** `string` *required*

The selected option ID.

**fields.answer.label** `string` *required*

The selected option label.

**fields.answer.group\_id** `integer`

The selected group ID for a `group_chooser` field.

**fields.answers** `array`

The selected answers for a field that accepts multiple values.

**fields.answers properties**

**fields.answers.id** `string` *required*

The selected option ID.

**fields.answers.label** `string` *required*

The selected option label.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string` *required*

The ID of the event author.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**form\_id** `string` *required*

The form ID.

**form\_type** `string`

The form type. Common values include `prechat`, `postchat`, and `ask_for_email`. This field is absent from chats started before the field was introduced.

**fields** `array` *required*

The fields in the form. See [Filled form fields](#filled-form-fields).

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`, `group_chooser`, `name`, `phone`, `question`, `radio`, `select`, `subject`, `textarea`.

**fields.id** `string` *required*

The form field ID. The value must be unique within the form.

**fields.label** `string` *required*

The form field label.

**fields.answer** `any`

The answer to the form field.

**fields.answer properties**

**fields.answer.id** `string` *required*

The selected option ID.

**fields.answer.label** `string` *required*

The selected option label.

**fields.answer.group\_id** `integer`

The selected group ID for a `group_chooser` field.

**fields.answers** `array`

The selected answers for a field that accepts multiple values.

**fields.answers properties**

**fields.answers.id** `string` *required*

The selected option ID.

**fields.answers.label** `string` *required*

The selected option label.

```json Sample Filled form in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "type": "filled_form",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "form_id": "1473433500211",
  "form_type": "prechat",
  "fields": [
    {
      "type": "name",
      "id": "154417206262603539",
      "label": "Your name",
      "answer": "Thomas Anderson"
    },
    {
      "type": "email",
      "id": "154417206262601584",
      "label": "Your email",
      "answer": "t.anderson@example.com"
    },
    {
      "type": "radio",
      "id": "154417206262602571",
      "label": "Chat purpose",
      "answer": {
        "id": "0",
        "label": "Support"
      }
    },
    {
      "type": "checkbox",
      "id": "154417206262604640",
      "label": "Company industry",
      "answers": [
        {
          "id": "0",
          "label": "automotive"
        },
        {
          "id": "1",
          "label": "it"
        }
      ]
    },
    {
      "type": "group_chooser",
      "id": "154417206262605324",
      "label": "Choose department",
      "answer": {
        "id": "2",
        "group_id": 1,
        "label": "Marketing"
      }
    }
  ]
}
```

### Message

The **Message** event contains a text message sent to chat users.

Request

**custom\_id** `string`

The custom event ID.

**text** `string` *required*

The message text. The maximum raw text size is 16 KB. A UTF-8 character can use up to 4 bytes. Split longer text into multiple messages.

**type** `string` *required*

The event type. Must be `message`.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**postback** `object`

The postback that generated the message from a rich message event.

**postback properties**

**postback.id** `string` *required*

The ID of the postback from the rich message event.

**postback.thread\_id** `string` *required*

The ID of the thread containing the rich message event.

**postback.event\_id** `string` *required*

The ID of the rich message event.

**postback.type** `string`

The postback type. Use it together with `postback.value`; if either field is present, the other is required.

**postback.value** `string`

The postback value. Use it together with `postback.type`; if either field is present, the other is required.

**postback.ecommerce** `object`

The ecommerce data from the rich message.

**postback.ecommerce properties**

**postback.ecommerce.product\_id** `string` *required*

The ID of the product displayed in the rich message.

**postback.ecommerce.option\_id** `string`

The ID of the selected product option.

**postback.ecommerce.quantity** `number`

The product quantity.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string` *required*

The ID of the event author.

**text** `string` *required*

The message text.

**postback** `object`

The postback that generated the message from a rich message event.

**postback properties**

**postback.id** `string` *required*

The ID of the postback from the rich message event.

**postback.thread\_id** `string` *required*

The ID of the thread containing the rich message event.

**postback.event\_id** `string` *required*

The ID of the rich message event.

**postback.type** `string`

The postback type. Use it together with `postback.value`; if either field is present, the other is required.

**postback.value** `string`

The postback value. Use it together with `postback.type`; if either field is present, the other is required.

**postback.ecommerce** `object`

The ecommerce data from the rich message.

**postback.ecommerce properties**

**postback.ecommerce.product\_id** `string`

The ID of the product displayed in the rich message.

**postback.ecommerce.option\_id** `string`

The ID of the selected product option.

**postback.ecommerce.quantity** `number`

The product quantity.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

```json Sample Message in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "type": "message",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "text": "hello there",
  "postback": {
    "id": "action_call",
    "thread_id": "K600PKZON8",
    "event_id": "75a90b82-e6a4-4ded-b3eb-cb531741ee0d",
    "type": "phone",
    "value": "790034890",
    "ecommerce": {
      "product_id": "prod123",
      "option_id": "opt1",
      "quantity": 1
    }
  },
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  }
}
```

### Rich message

The **Rich message** event contains interactive rich message content.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `rich_message`.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**template\_id** `string` *required*

The template that determines how the rich message is displayed. Possible values: `cards`, `sticker`, `quick_replies`.

**elements** `array`

An array of up to 10 rich message elements.

**elements properties**

**elements.title** `string` *required*

The formatted title of the rich message element.

**elements.subtitle** `string` *required*

The formatted subtitle of the rich message element.

**elements.image** `object` *required*

The image displayed in the rich message element.

**elements.image properties**

**elements.image.name** `string`

The image file name.

**elements.image.url** `string` *required*

The image URL.

**elements.image.content\_type** `string`

The image media type.

**elements.image.size** `integer`

The image file size in bytes.

**elements.image.width** `integer`

The image width in pixels.

**elements.image.height** `integer`

The image height in pixels.

**elements.image.alternative\_text** `string`

The alternative text for the image.

**elements.buttons** `array`

An array of up to 13 buttons displayed in the rich message element.

**elements.buttons properties**

**elements.buttons.text** `string` *required*

The text displayed on the button.

**elements.buttons.type** `string`

The behavior after a user selects the button. If provided,
`elements.buttons.value` is also required. Possible values:
`webview`, `message`, `url`, `phone`.

**elements.buttons.value** `string`

The button value. If provided, `elements.buttons.type` is also
required. For a `webview` button, it can provide a custom Moment
title.

**elements.buttons.webview\_height** `string`

The webview height. Required when `elements.buttons.type` is `webview`. Possible values: `compact`, `full`, `tall`.

**elements.buttons.postback\_id** `string` *required*

The action identifier sent through `send_rich_message_postback`.

**elements.buttons.user\_ids** `array` *required*

The IDs of users who sent the postback with `"toggled": true`.

**elements.buttons.target** `string`

The browsing context for a `url` button. Possible values: `new`, `current`.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string` *required*

The ID of the event author.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**properties** `object`

Custom properties organized by namespace and property name. See [Properties](#properties).

**template\_id** `string` *required*

The template that determines how the rich message is displayed.

**elements** `array`

An array of up to 10 rich message elements.

**elements properties**

**elements.title** `string` *required*

The formatted title of the rich message element.

**elements.subtitle** `string` *required*

The formatted subtitle of the rich message element.

**elements.image** `object` *required*

The image displayed in the rich message element.

**elements.image properties**

**elements.image.name** `string`

The image file name.

**elements.image.url** `string` *required*

The image URL.

**elements.image.content\_type** `string`

The image media type.

**elements.image.size** `integer`

The image file size in bytes.

**elements.image.width** `integer`

The image width in pixels.

**elements.image.height** `integer`

The image height in pixels.

**elements.image.alternative\_text** `string`

The alternative text for the image.

**elements.buttons** `array`

An array of up to 13 buttons displayed in the rich message element.

**elements.buttons properties**

**elements.buttons.button\_id** `string`

The button ID. Returned for buttons generated by smart actions.

**elements.buttons.text** `string` *required*

The text displayed on the button.

**elements.buttons.type** `string`

The button behavior. This field is returned with
`elements.buttons.value`.

**elements.buttons.value** `string`

The button value. This field is returned with
`elements.buttons.type`.

**elements.buttons.webview\_height** `string`

The webview height. Present when `elements.buttons.type` is
`webview`. Possible values: `compact`, `full`, `tall`.

**elements.buttons.postback\_id** `string` *required*

The action identifier sent through `send_rich_message_postback`.

**elements.buttons.user\_ids** `array` *required*

The IDs of users who sent the postback with `"toggled": true`.

**elements.buttons.role** `string`

The button role. Returned when the button defines a `role`
attribute.

**elements.buttons.target** `string`

The browsing context for a `url` button. Possible values: `new`, `current`.

**elements.ecommerce** `object`

The product and product variant information. Present when `template_id` is `ecommerce`.

**elements.ecommerce properties**

**elements.ecommerce.view\_type** `string`

The presentation of the product and its options. Possible values: `tags`, `swatch`, `images`, `select`.

**elements.ecommerce.product\_id** `string`

The product ID.

**elements.ecommerce.label** `string`

The product label.

**elements.ecommerce.options** `array`

The product options.

**elements.ecommerce.options properties**

**elements.ecommerce.options.option\_id** `string` *required*

The product option ID.

**elements.ecommerce.options.label** `string` *required*

The product option label.

**elements.ecommerce.options.price** `string`

The product option price.

**elements.ecommerce.options.regular\_price** `string`

The regular product option price.

**elements.ecommerce.options.currency** `string`

The currency of the product option price.

**elements.ecommerce.options.color** `string`

The product option color.

**elements.ecommerce.options.image\_url** `string`

The product option image URL.

**elements.ecommerce.options.image\_thumbnail\_url** `string`

The product option thumbnail URL.

**elements.ecommerce.options.available** `boolean`

Whether the product option is available.

**elements.ecommerce.options.selected** `boolean`

Whether the product option is selected.

**elements.ecommerce.addons** `array`

The product add-ons.

**elements.ecommerce.addons properties**

**elements.ecommerce.addons.addon\_type** `string` *required*

The product add-on type.

**elements.ecommerce.addons.range\_from** `string`

The start of the product add-on price range.

**elements.ecommerce.addons.range\_to** `string`

The end of the product add-on price range.

**elements.ecommerce.addons.currency** `string`

The currency of the product add-on price range.

```json Sample Rich message in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "type": "rich_message",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "template_id": "ecommerce",
  "elements": [
    {
      "title": "Lorem ipsum dolor.",
      "subtitle": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "image": {
        "name": "image25.png",
        "url": "https://example.com/image25.png",
        "content_type": "image/png",
        "size": 123444,
        "width": 640,
        "height": 480,
        "alternative_text": "A picture of lorem ipsum"
      },
      "buttons": [
        {
          "text": "yes",
          "postback_id": "action_yes",
          "user_ids": ["b7eff798-f8df-4364-8059-649c35c9ed0c"]
        },
        {
          "text": "no",
          "postback_id": "action_no",
          "user_ids": []
        },
        {
          "type": "phone",
          "text": "value",
          "value": "790034890",
          "webview_height": "tall",
          "postback_id": "action_call",
          "user_ids": [],
          "target": "current"
        }
      ],
      "ecommerce": {
        "view_type": "tags",
        "product_id": "prod123",
        "label": "Sample product",
        "options": [
          {
            "option_id": "opt1",
            "label": "Black",
            "price": "100",
            "regular_price": "120",
            "currency": "USD",
            "color": "#000000",
            "image_url": "https://example.com/product-black.png",
            "image_thumbnail_url": "https://example.com/product-black-thumbnail.png",
            "available": true,
            "selected": true
          }
        ],
        "addons": [
          {
            "addon_type": "warranty",
            "range_from": "10",
            "range_to": "20",
            "currency": "USD"
          }
        ]
      }
    }
  ]
}
```

### Custom

The **Custom** event contains a customizable payload.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `custom`.

**content** `object`

The custom JSON content.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**author\_id** `string` *required*

The ID of the event author.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**content** `object`

The custom JSON content.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

```json Sample Custom event in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "type": "custom",
  "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "content": {
    "custom": {
      "nested": "json"
    }
  },
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  }
}
```

### System message

The **System message** event is generated by the system in specific situations.

Request

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type. Must be `system_message`.

**text** `string`

The message text.

**system\_message\_type** `string` *required*

The system message type. See [System message
types](https://www.text.com/docs/api/events-and-properties/system-activities.md#system-messages).

**text\_vars** `object`

The variables substituted into the system message text.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**type** `string` *required*

The event type.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

**text** `string`

The message text.

**system\_message\_type** `string` *required*

The system message type. See [System message
types](https://www.text.com/docs/api/events-and-properties/system-activities.md#system-messages).

**text\_vars** `object`

The variables substituted into the system message text.

```json Sample System message in response theme={null}
{
  "id": "0affb00a-82d6-4e07-ae61-56ba5c36f743",
  "custom_id": "31-0C-1C-07-DB-16",
  "created_at": "2017-10-12T15:19:21.010200Z",
  "type": "system_message",
  "text": "hello there",
  "system_message_type": "routing.assigned",
  "text_vars": {
    "agent": "John Doe"
  }
}
```

### System

System event is an extension and a future replacement for [System message](#system-message). Similarly, it is a native system event sent in specific situations.

**Request**

It is not possible to send a System event in API version 3.6.

Response

**id** `string` *required*

The event ID.

**custom\_id** `string`

The custom event ID.

**source** `string` *required*

The system that generated the event. See [System event
sources](https://www.text.com/docs/api/events-and-properties/system-activities.md#system-events).

**type** `string` *required*

The event type. Always `system`.

**recipients** `string`

The event recipients. Possible values: `all`, `agents`.

**properties** `object`

Custom properties organized by namespace and property name. See
[Properties](#properties).

**subtype** `string` *required*

The system event subtype. See [System event
subtypes](https://www.text.com/docs/api/events-and-properties/system-activities.md#system-events).

**version** `integer` *required*

The system event schema version.

**details** `string` *required*

The JSON-encoded event details.

**created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond precision.

```json Sample System event in response theme={null}
{
  "id": "17f5ac89-e578-4d3f-9ab9-675be6209b00",
  "custom_id": "shopify_1744119867",
  "source": "cdp",
  "type": "system",
  "subtype": "store_order_was_created",
  "version": 1,
  "details": "{\"store\":{\"id\":\"my-store\",\"platform\":\"shopify\",\"uuid\":\"70cb9e59-b639-41c5-81cf-71db11972cff\",\"url\":\"https://my-store.myshopify.com\",\"name\":\"My Store\"},\"order\":{\"id\":\"gid://shopify/Order/1234567890\",\"order_number\":\"#1001\",\"currency\":\"USD\",\"total_price\":123.45,\"line_items\":[{\"title\":\"Product Name\",\"quantity\":2,\"price\":49.99,\"sku\":\"SKU123\",\"variant_id\":\"gid://shopify/ProductVariant/12345678901234\"}]}}",
  "created_at": "2017-10-12T15:19:21.010200Z"
}
```

## Users

Users represent customers and agents participating in chats.

### Customer

**id** `string` *required*

The customer ID.

**type** `string` *required*

The user type. Always `customer`.

**avatar** `string`

The customer avatar URL.

**email** `string`

The customer email address.

**email\_verified** `boolean`

Whether the customer confirmed their email address.

**suggested\_email** `string`

The email address suggested from tracked customer activity, such as a form
submission. The customer has not confirmed this address. It is independent
of `email` and isn't used for identity merging or segment membership,
including built-in lead segments.

**name** `string`

The customer name.

**name\_is\_default** `boolean` *required*

If `true`, the customer's name is a placeholder set by Text according to the
organization's language settings, including custom translations.

**phone\_number** `string`

The customer phone number.

**session\_fields** `array`

Custom key-value pairs available for the duration of the customer session.

**session\_fields properties**

**session\_fields.\<key>** `string`

A custom session field value.

**omnichannel** `object`

The customer's omnichannel data.

**omnichannel properties**

**omnichannel.fbmessenger** `array`

The customer's Facebook Messenger profiles.

**omnichannel.fbmessenger properties**

**omnichannel.fbmessenger.id** `string` *required*

The Facebook Messenger profile ID.

**omnichannel.fbmessenger.name** `string`

The profile name.

**omnichannel.fbmessenger.first\_name** `string`

The profile first name.

**omnichannel.fbmessenger.last\_name** `string`

The profile last name.

**omnichannel.fbmessenger.profile\_pic** `string`

The profile picture URL.

**omnichannel.fbmessenger.gender** `string`

The profile gender.

**omnichannel.fbmessenger.locale** `string`

The profile locale.

**omnichannel.fbmessenger.is\_verified\_user** `boolean`

Whether Facebook verified the user.

**omnichannel.twilio** `array`

The customer's Twilio profiles.

**omnichannel.twilio properties**

**omnichannel.twilio.phone\_number** `string` *required*

The profile phone number.

**omnichannel.whatsapp** `array`

The customer's WhatsApp profiles.

**omnichannel.whatsapp properties**

**omnichannel.whatsapp.id** `string` *required*

The WhatsApp profile ID.

**omnichannel.whatsapp.name** `string`

The profile name.

**omnichannel.whatsapp.phone\_number** `string` *required*

The profile phone number.

**omnichannel.instagram** `array`

The customer's Instagram profiles.

**omnichannel.instagram properties**

**omnichannel.instagram.ig\_user\_id** `string` *required*

The Instagram user ID.

**omnichannel.instagram.username** `string`

The Instagram username.

**omnichannel.instagram.name** `string`

The Instagram display name.

**omnichannel.instagram.profile\_pic** `string`

The URL of the Instagram profile picture.

**omnichannel.instagram.follower\_count** `integer`

The number of the account's followers.

**omnichannel.instagram.is\_verified\_user** `boolean`

If `true`, the Instagram account is verified.

**omnichannel.instagram.is\_user\_follow\_business** `boolean`

If `true`, the customer follows the business account.

**omnichannel.instagram.is\_business\_follow\_user** `boolean`

If `true`, the business account follows the customer.

**omnichannel.telegram** `array`

The customer's Telegram profiles.

**omnichannel.telegram properties**

**omnichannel.telegram.telegram\_user\_id** `integer` *required*

The Telegram user ID.

**omnichannel.telegram.first\_name** `string`

The customer's first name.

**omnichannel.telegram.last\_name** `string`

The customer's last name.

**omnichannel.telegram.username** `string`

The Telegram username.

**omnichannel.telegram.language\_code** `string`

The language configured in the customer's Telegram client.

**omnichannel.telegram.display\_name** `string`

The Telegram display name.

**omnichannel.telegram.is\_premium** `boolean`

If `true`, the customer has a Telegram Premium subscription.

**omnichannel.sms** `array`

The customer's SMS profiles.

**omnichannel.sms properties**

**omnichannel.sms.phone\_number** `string` *required*

The profile phone number.

**address** `object`

The customer's address data.

**address properties**

**address.address** `string`

The street address.

**address.city** `string`

The city.

**address.country** `string`

The country.

**address.state** `string`

The state or region.

**address.postal\_code** `string`

The postal code.

**statistics** `object`

Counters describing the customer's activity.

**statistics properties**

**statistics.chats\_count** `integer` *required*

The number of chats started by the customer.

**statistics.threads\_count** `integer` *required*

The number of threads started by the customer.

**statistics.visits\_count** `integer` *required*

The number of customer visits.

**statistics.page\_views\_count** `integer` *required*

The number of customer page views.

**statistics.greetings\_accepted\_count** `integer` *required*

The number of greetings accepted by the customer.

**statistics.greetings\_converted\_count** `integer` *required*

The number of greetings that resulted in a conversion.

**present** `boolean`

If `true`, the customer is present in the chat.

**events\_seen\_up\_to** `string`

The timestamp of the most recent event seen by the customer, in RFC 3339
format. All earlier events are considered seen.

```json Sample Customer data structure theme={null}
{
  "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
  "type": "customer",
  "name": "Thomas Anderson",
  "email": "t.anderson@example.com",
  "email_verified": false,
  "suggested_email": "t.anderson@example.com",
  "avatar": "https://example.com/avatar.png",
  "phone_number": "+18008529001",
  "session_fields": [
    {
      "custom_key": "custom_value"
    },
    {
      "another_custom_key": "another_custom_value"
    }
  ],
  "present": true,
  "events_seen_up_to": "2017-10-12T15:19:21.010200Z",
  "omnichannel": {
    "fbmessenger": [
      {
        "id": "fb_messenger_id",
        "name": "Thomas Anderson",
        "first_name": "Thomas",
        "last_name": "Anderson",
        "profile_pic": "https://example.com/avatars/1.png",
        "gender": "male",
        "locale": "en_US",
        "is_verified_user": true
      }
    ],
    "twilio": [
      {
        "phone_number": "+18008529001"
      }
    ],
    "whatsapp": [
      {
        "id": "15550001234",
        "name": "Thomas Anderson",
        "phone_number": "+15550001234"
      }
    ],
    "instagram": [
      {
        "ig_user_id": "17841405793187218",
        "username": "thomas.anderson",
        "name": "Thomas Anderson",
        "profile_pic": "https://example.com/avatars/instagram.png",
        "follower_count": 120,
        "is_verified_user": true,
        "is_user_follow_business": true,
        "is_business_follow_user": false
      }
    ],
    "telegram": [
      {
        "telegram_user_id": 123456789,
        "first_name": "Thomas",
        "last_name": "Anderson",
        "username": "thomas_anderson",
        "language_code": "en",
        "display_name": "Thomas Anderson",
        "is_premium": true
      }
    ],
    "sms": [
      {
        "phone_number": "+15550000002"
      }
    ]
  },
  "address": {
    "address": "1600 Pennsylvania Avenue NW",
    "city": "Washington",
    "country": "United States",
    "state": "DC",
    "postal_code": "20500"
  }
}
```

### Agent

**id** `string` *required*

The agent ID.

**type** `string` *required*

The user type. Always `agent`.

**name** `string`

The agent's name.

**avatar** `string` *required*

The URL of the agent's avatar.

**present** `boolean`

If `true`, the agent is present in the chat.

**events\_seen\_up\_to** `string`

The timestamp of the most recent event seen by the agent, in RFC 3339
format. All earlier events are considered seen.

**job\_title** `string`

The agent's job title.

```json Sample Agent data structure theme={null}
{
  "id": "b5657aff34dd32e198160d54666df9d8",
  "type": "agent",
  "name": "Agent Smith",
  "avatar": "cdn.livechatinc.com/avatars/1.png",
  "present": true,
  "events_seen_up_to": "2017-10-12T15:19:21.010200Z",
  "job_title": "Support Agent"
}
```

## Other common structures

These structures support chats, forms, properties, and threads.

### Access

**access.group\_ids** `array`

The IDs of groups that can access the resource. Group `0` grants access to
all agents.

```json Sample Access data structure theme={null}
{
  "access": {
    "group_ids": [1, 2]
  }
}
```

### Chats

**id** `string` *required*

The chat ID.

**thread** `object`

The chat thread. See [Threads](#threads).

**users** `array`

The chat users. See [Customer](#customer) and [Agent](#agent).

**properties** `object`

Custom chat properties organized by namespace and property name. See
[Properties](#properties).

**properties properties**

**properties.\<namespace>** `object`

A property namespace.

**properties.\<namespace> properties**

**properties.\<namespace>.\<property\_name>** `any`

A property value.

**access** `object`

The chat access settings.

**access properties**

**access.group\_ids** `array`

The IDs of groups that can access the chat. Group `0` grants access to
all agents.

```json Sample Chat data structure theme={null}
{
  "id": "PJ0MRSHTDG",
  "thread": {
    "id": "QA1B38GHGI",
    "created_at": "2020-05-07T07:11:28.288340Z",
    "active": false,
    "user_ids": [
      "bbb67d600796e9f277e360e842418833",
      "b7eff798-f8df-4364-8059-649c35c9ed0c"
    ],
    "events": [
      {
        "id": "QA1B38GHGI_1",
        "created_at": "2020-05-14T07:22:40.269000Z",
        "type": "message",
        "properties": {
          "source": {
            "client_id": "0805e283233042b37f460ed8fbf22160"
          }
        },
        "text": "hello",
        "author_id": "bbb67d600796e9f277e360e842418833",
        "custom_id": "1589440960204.71699349177"
      },
      {
        "id": "QA1B38GHGI_3",
        "created_at": "2020-05-14T08:18:44.015000Z",
        "type": "system_message",
        "text": "The chat was closed because Agent Smith had lost internet connection",
        "system_message_type": "routing.archived_disconnected",
        "text_vars": {
          "agent": "Agent Smith"
        }
      }
    ],
    "properties": {
      "property_namespace": {
        "property_name": "property_value"
      }
    },
    "access": {
      "group_ids": [0]
    },
    "previous_thread_id": "K600PKZOM8",
    "next_thread_id": "K600PKZOO8"
  },
  "users": [
    {
      "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "type": "customer",
      "present": true
    },
    {
      "id": "bbb67d600796e9f277e360e842418833",
      "name": "Agent Smith",
      "events_seen_up_to": "2020-05-14T07:22:37.287496Z",
      "type": "agent",
      "present": false,
      "avatar": "https://cdn.livechat-files.com/api/file/avatar.png",
      "job_title": "Support Agent"
    }
  ],
  "access": {
    "group_ids": [0]
  },
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  }
}
```

### Chat summaries

**Chat summary** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat summary** includes `last_event_per_type`.

**id** `string` *required*

The chat ID.

**last\_thread\_id** `string`

The ID of the most recent thread.

**last\_thread\_created\_at** `string`

The creation timestamp of the most recent thread, in RFC 3339 format with
microsecond precision.

**users** `array`

The chat users. See [Customer](#customer) and [Agent](#agent).

**last\_event\_per\_type** `object` *required*

The most recent event of each event type, keyed by event type.

**last\_event\_per\_type properties**

**last\_event\_per\_type.\<event\_type>** `object`

The most recent event of the specified type.

**last\_event\_per\_type.\<event\_type> properties**

**last\_event\_per\_type.\<event\_type>.thread\_id** `string` *required*

The ID of the thread containing the event.

**last\_event\_per\_type.\<event\_type>.thread\_created\_at** `string` *required*

The thread creation timestamp in RFC 3339 format with microsecond
precision.

**last\_event\_per\_type.\<event\_type>.event** `object` *required*

The event data. See [Events](#events).

**properties** `object`

Custom chat properties organized by namespace and property name. See
[Properties](#properties).

**access** `object`

The chat access settings. See [Access](#access).

**active** `boolean` *required*

If `true`, the chat's most recent thread is active.

```json Sample Chat summary data structure theme={null}
{
  "id": "PJ0MRSHTDG",
  "last_thread_id": "QA1B38GHGI",
  "last_thread_created_at": "2020-05-08T08:22:21.128420Z",
  "users": [
    {
      "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "type": "customer",
      "present": true
    },
    {
      "id": "bbb67d600796e9f277e360e842418833",
      "name": "Agent Smith",
      "events_seen_up_to": "2020-05-14T07:22:37.287496Z",
      "type": "agent",
      "present": false,
      "avatar": "https://cdn.livechat-files.com/api/file/avatar.png",
      "job_title": "Support Agent"
    }
  ],
  "last_event_per_type": {
    "message": {
      "thread_id": "QA1B38GHGI",
      "thread_created_at": "2020-05-14T07:22:30.779000Z",
      "event": {
        "id": "QA1B38GHGI_1",
        "created_at": "2020-05-14T07:22:40.269000Z",
        "type": "message",
        "properties": {
          "property_namespace": {
            "property_name": "property_value"
          }
        },
        "text": "Hello",
        "author_id": "bbb67d600796e9f277e360e842418833",
        "custom_id": "1589440960204.71699349177"
      }
    },
    "system_message": {
      "thread_id": "QA1B38GHGI",
      "thread_created_at": "2020-05-14T07:22:30.779000Z",
      "event": {
        "id": "QA1B38GHGI_3",
        "created_at": "2020-05-14T08:18:44.015000Z",
        "type": "system_message",
        "text": "The chat was closed because Agent Smith had lost internet connection",
        "system_message_type": "routing.archived_disconnected",
        "text_vars": {
          "agent": "Agent Smith"
        }
      }
    }
  },
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "access": {
    "group_ids": [0]
  },
  "active": false
}
```

### Forms

A template of a prechat, postchat, or a ticket form.

**id** `string`

The form ID.

**fields** `array` *required*

The fields in the form. See [Form fields](#form-fields).

**fields properties**

**fields.type** `string` *required*

The field type. Possible values: `header`, `checkbox`, `email`, `name`,
`question`, `subject`, `textarea`, `phone`, `date`, `group_chooser`,
`radio`, `select`.

**fields.id** `string`

Field ID, for all field types.

**fields.label** `string` *required*

The field label.

**fields.required** `boolean`

Whether an answer to the field is required.

**fields.options** `array`

For `checkbox`, `group_chooser`, `radio` and `select`.

**fields.options properties**

**fields.options.id** `string` *required*

An identifier of each option a customer can choose.

**fields.options.label** `string` *required*

The field label.

**fields.options.checked** `boolean`

If `true`, the option is selected by default.

**fields.options.group\_id** `integer`

The group ID for a `group_chooser` option.

```json Sample Form data structure theme={null}
{
  "id": "157986144052005549",
  "fields": [
    {
      "id": "157986144052003238",
      "type": "header",
      "label": "Welcome to our chat! Please fill in the form below before starting the chat."
    },
    {
      "id": "157986144052008371",
      "type": "name",
      "label": "Name:",
      "required": false
    },
    {
      "id": "157986144052005782",
      "type": "email",
      "label": "E-mail:",
      "required": false
    },
    {
      "id": "157986144052009331",
      "type": "group_chooser",
      "label": "Choose a department:",
      "required": true,
      "options": [
        {
          "id": "0",
          "group_id": 1,
          "label": "Marketing"
        },
        {
          "id": "1",
          "group_id": 2,
          "label": "Sales"
        },
        {
          "id": "2",
          "group_id": 0,
          "label": "General"
        }
      ]
    }
  ]
}
```

### Form fields

A component of the [Form](#form) event.

**fields** `array` *required*

The fields in the form.

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`,
`group_chooser`, `name`, `phone`, `question`, `radio`, `select`,
`subject`, `textarea`.

**fields.id** `string` *required*

The form field ID.

**fields.label** `string` *required*

The form field label.

**fields.required** `boolean`

If `true`, an answer to the field is required.

**fields.options** `array`

The selectable options for `checkbox`, `group_chooser`, `radio`, and
`select` fields.

**fields.options properties**

**fields.options.id** `string` *required*

The option ID.

**fields.options.label** `string` *required*

The option label.

**fields.options.checked** `boolean`

If `true`, the option is selected by default.

**fields.groups** `array`

The groups available for a `group_chooser` field.

**fields.groups properties**

**fields.groups.id** `string` *required*

The group ID.

**fields.groups.label** `string` *required*

The group label.

**fields.groups.checked** `boolean`

If `true`, the group is selected by default.

```json Sample Form fields theme={null}
{
  "fields": [
    {
      "type": "name",
      "id": "154417206262603539",
      "label": "Your name"
    },
    {
      "type": "email",
      "id": "154417206262601584",
      "label": "Your email"
    },
    {
      "type": "radio",
      "id": "154417206262602571",
      "label": "Chat purpose"
    },
    {
      "type": "checkbox",
      "id": "154417206262604640",
      "label": "Company industry"
    },
    {
      "type": "group_chooser",
      "id": "154417206262605324",
      "label": "Choose department"
    }
  ]
}
```

### Filled form fields

A component of the [Filled form](#filled-form) event.

**fields** `array` *required*

The fields in the submitted form.

**fields properties**

**fields.type** `string` *required*

The form field type. Possible values: `checkbox`, `date`, `email`,
`group_chooser`, `name`, `phone`, `question`, `radio`, `select`,
`subject`, `textarea`.

**fields.id** `string` *required*

The form field ID.

**fields.label** `string` *required*

The form field label.

**fields.answer** `any`

The submitted answer.

**fields.answer properties**

**fields.answer.id** `string` *required*

The selected option ID.

**fields.answer.label** `string` *required*

The selected option label.

**fields.answer.group\_id** `integer`

The selected group ID for a `group_chooser` field.

**fields.answers** `array`

The submitted answers for a field that accepts multiple values.

**fields.answers properties**

**fields.answers.id** `string` *required*

The selected option ID.

**fields.answers.label** `string` *required*

The selected option label.

```json Sample Filled form fields theme={null}
{
  "fields": [
    {
      "type": "name",
      "id": "154417206262603539",
      "label": "Your name",
      "answer": "Thomas Anderson"
    },
    {
      "type": "email",
      "id": "154417206262601584",
      "label": "Your email",
      "answer": "t.anderson@example.com"
    },
    {
      "type": "radio",
      "id": "154417206262602571",
      "label": "Chat purpose",
      "answer": {
        "id": "0",
        "label": "Support"
      }
    },
    {
      "type": "checkbox",
      "id": "154417206262604640",
      "label": "Company industry",
      "answers": [
        {
          "id": "0",
          "label": "automotive"
        },
        {
          "id": "1",
          "label": "it"
        }
      ]
    },
    {
      "type": "group_chooser",
      "id": "154417206262605324",
      "label": "Choose department",
      "answer": {
        "id": "2",
        "group_id": 1,
        "label": "Marketing"
      }
    }
  ]
}
```

### Properties

Properties are key-value pairs that can be set on a chat, thread, or event. For
details, see the [Configuration API](https://www.text.com/docs/api/configuration/v3.6.md).

```json Sample Properties data structure theme={null}
{
  "properties": {
    "0805e283233042b37f460ed8fbf22160": {
      "string_property": "string value"
    }
  }
}
```

### Threads

**id** `string` *required*

The thread ID.

**access** `object`

The thread access settings.

**access properties**

**access.group\_ids** `array`

The IDs of groups that can access the thread. Group `0` grants access
to all agents.

**active** `boolean` *required*

Whether the thread is active.

**user\_ids** `array` *required*

The IDs of users participating in the thread.

**events** `array`

The events in the thread.

**events properties**

**events.id** `string` *required*

The event ID.

**events.created\_at** `string` *required*

The event creation timestamp in RFC 3339 format with microsecond
precision.

**events.type** `string` *required*

The event type.

**events.properties** `object`

The event properties.

**events.text** `string`

The event text.

**events.system\_message\_type** `string` *required*

The system message type. Present for system message events.

**events.text\_vars** `object`

The variables substituted into the system message text.

**events.author\_id** `string`

The ID of the event author.

**events.custom\_id** `string`

The custom event ID.

**properties** `object`

Custom thread properties organized by namespace and property name. See
[Properties](#properties).

**properties properties**

**properties.\<namespace>** `object`

A property namespace.

**properties.\<namespace> properties**

**properties.\<namespace>.\<property\_name>** `any`

A property value.

**queue** `object`

The queue information. Present only when the chat is queued.

**queue properties**

**queue.position** `integer` *required*

The chat position in the queue.

**queue.wait\_time** `integer` *required*

The approximate wait time for an available agent, in seconds.

**queue.queued\_at** `string` *required*

The timestamp when the chat entered the queue.

**previous\_thread\_id** `string`

The ID of the preceding thread.

**next\_thread\_id** `string`

The ID of the following thread.

**created\_at** `string` *required*

The server-generated thread creation timestamp in RFC 3339 format with
microsecond precision.

```json Sample Thread data structure theme={null}
{
  "id": "K600PKZON8",
  "active": true,
  "user_ids": ["b7eff798-f8df-4364-8059-649c35c9ed0c"],
  "events": [
    {
      "id": "QA1B38GHGI_1",
      "created_at": "2020-05-14T07:22:40.269000Z",
      "type": "message",
      "properties": {
        "property_namespace": {
          "property_name": "property_value"
        }
      },
      "text": "hello",
      "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "custom_id": "1589440960204.71699349177"
    }
  ],
  "properties": {
    "property_namespace": {
      "property_name": "property_value"
    }
  },
  "access": {
    "group_ids": [0]
  },
  "queue": {
    "position": 42,
    "wait_time": 1337,
    "queued_at": "2020-05-07T07:11:28.288340Z"
  },
  "previous_thread_id": "K600PKZOM8",
  "next_thread_id": "K600PKZOO8",
  "created_at": "2020-05-07T07:11:28.288340Z"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.