Skip to content

feat(docs): update docs for fixing collision in summary naming #1623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oliwiapolec merged 3 commits into from
Dec 11, 2025
Merged

feat(docs): update docs for fixing collision in summary naming #1623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1885633
update docs for fixing collision in summary naming
Slimak-Text Nov 25, 2025
0b61c12
cr fixes
Slimak-Text Dec 2, 2025
c900247
change exports
Slimak-Text Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion payloads/messaging/v3.7/agent-chat-api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export { default as customer } from "./users/customer.json";

export { default as access } from "./other-structures/access.json";
export { default as chat } from "./other-structures/chat.json";
export { default as chatSummary } from "./other-structures/chatSummary.json";
export { default as chatInfo } from "./other-structures/chatInfo.json";
export { default as formFields } from "./other-structures/formFields.json";
export { default as filledFormFields } from "./other-structures/filledFormFields.json";
export { default as properties } from "./other-structures/properties.json";
Expand Down
2 changes: 1 addition & 1 deletion ...hat-api/other-structures/chatSummary.json → ...t-chat-api/other-structures/chatInfo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "PJ0MRSHTDG",
"last_thread_summary": {
"last_thread_info": {
"id": "QA37PVJ75B",
"created_at": "2020-05-12T11:42:47.383000Z",
"user_ids": [
Expand Down
2 changes: 1 addition & 1 deletion payloads/messaging/v3.7/customer-chat-api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export { default as customer } from "./users/customer.json"

export { default as access } from "./other-structures/access.json"
export { default as chat } from "./other-structures/chat.json"
export { default as chatSummary } from "./other-structures/chatSummary.json"
export { default as chatInfo } from "./other-structures/chatInfo.json"
export { default as form } from "./other-structures/form.json"
export { default as formFields } from "./other-structures/formFields.json"
export { default as filledFormFields } from "./other-structures/filledFormFields.json"
Expand Down
2 changes: 1 addition & 1 deletion ...hat-api/other-structures/chatSummary.json → ...r-chat-api/other-structures/chatInfo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@
]
},
"active": false
}
}
3 changes: 3 additions & 0 deletions src/pages/messaging/agent-chat-api/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ The developer preview version provides a preview of the upcoming changes to the
### Chats

- The **List Archives** ([Web](/messaging/agent-chat-api/v3.7/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has a new filter, `chat_ids`.
- The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`.
- The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` was renamed to `chats_info`.
- The **Chat summary** data structure is renamed to [**Chat info**](/messaging/agent-chat-api/v3.7/data-structures#chat-info) and its field `last_thread_summary` is renamed to `last_thread_info`.

## [v3.6] - 2025-08-07

Expand Down
8 changes: 4 additions & 4 deletions src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da

- [Access](#access)
- [Chats](#chats)
- [Chat summaries](#chat-summaries)
- [Chat info](#chat-info)
- [Form fields](#form-fields)
- [Filled form fields](#filled-form-fields)
- [Properties](#properties)
Expand All @@ -447,11 +447,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
| `properties` | optional | |
| `access` | optional | |

## Chat summaries
## Chat info

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

<CodeResponse version="v3.7" type="agent" title={'Sample Chat summary data structure'} json="chatSummary"/>
<CodeResponse version="v3.7" type="agent" title={'Sample Chat info data structure'} json="chatInfo"/>

## Form fields

Expand Down
12 changes: 6 additions & 6 deletions src/pages/messaging/agent-chat-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ curl -X POST \

### List Chats

It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to.
It returns the [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to.

#### Specifics

Expand All @@ -140,7 +140,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ
| ----------------------------------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. |
| `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. |
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. |
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. |
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
| `filters.properties.<namespace>.<name>.<filter_type>` | No | `any` | |
| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) |
Expand All @@ -159,7 +159,7 @@ There's only one value allowed for a single property.

| Field | Data type | Notes |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ |
| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures |
| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. |
| `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. |
| `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. |
| `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. |
Expand All @@ -182,7 +182,7 @@ curl -X POST \
```json
{
"next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional
"chats_summary": [{
"chats_info": [{
"id": "PJ0MRSHTDG",
"last_event_per_type": {
"message": {
Expand Down Expand Up @@ -210,7 +210,7 @@ curl -X POST \
}, {
// "Agent" user object
}],
"last_thread_summary": {
"last_thread_info": {
"id": "K600PKZON8",
"created_at": "2020-05-07T07:11:28.288340Z",
"user_ids": [
Expand Down Expand Up @@ -486,7 +486,7 @@ curl -X POST \

It returns a list of the chats an agent has access to. Together with a **chat**, the **events** of **one thread** from this chat are returned.

The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat summary**.
The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat info**.

#### Specifics

Expand Down
16 changes: 8 additions & 8 deletions src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require

### List Chats

It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to.
It returns [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) of the chats an agent has access to.

#### Specifics

Expand All @@ -182,7 +182,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ
| ----------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. |
| `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. |
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. |
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. |
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
| `filters.properties.<namespace>.<name>.<filter_type>` | No | `any` | |
| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) |
Expand All @@ -201,7 +201,7 @@ There's only one value allowed for a single property.

| Field | Data type | Notes |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ |
| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures |
| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. |
| `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. |
| `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. |
| `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. |
Expand Down Expand Up @@ -229,7 +229,7 @@ There's only one value allowed for a single property.
"success": true,
"payload": {
"next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional
"chats_summary": [{
"chats_info": [{
"id": "PJ0MRSHTDG",
"last_event_per_type": {
"message": {
Expand Down Expand Up @@ -257,7 +257,7 @@ There's only one value allowed for a single property.
}, {
// "Agent" user object
}],
"last_thread_summary": {
"last_thread_info": {
"id": "K600PKZON8",
"created_at": "2020-05-07T07:11:28.288340Z",
"user_ids": [
Expand Down Expand Up @@ -543,7 +543,7 @@ It returns a thread that the current agent has access to in a given chat.

It returns a list of the chats an agent has access to. Together with a **chat**, the **events** of **one thread** from this chat are returned.

The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat summary**.
The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only the **chat info**.

#### Specifics

Expand Down Expand Up @@ -2650,7 +2650,7 @@ __**__ These values mean:
"my_profile": {
// "User > My profile" object
},
"chats_summary": [{
"chats_info": [{
"id": "PJ0MRSHTDG",
"users": [
// array of "User" objects
Expand All @@ -2677,7 +2677,7 @@ __**__ These values mean:
}
// ...
},
"last_thread_summary": {
"last_thread_info": {
"id": "K600PKZON8",
"user_ids": ["smith@example.com"],
"properties": {
Expand Down
6 changes: 6 additions & 0 deletions src/pages/messaging/customer-chat-api/changelog/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ The developer preview version provides a preview of the upcoming changes to the

</Warning>

## [v3.7] - Developer preview

### Chats

- The **List Chats** ([Web](/messaging/customer-chat-api/v3.7/#list-chats) & [RTM](/messaging/customer-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`.

## [v3.6] - 2025-08-07

### Config
Expand Down
8 changes: 4 additions & 4 deletions src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da

- [Access](#access)
- [Chats](#chats)
- [Chat summaries](#chat-summaries)
- [Chat info](#chat-info)
- [Forms](#forms)
- [Form fields](#form-fields)
- [Filled form fields](#filled-form-fields)
Expand All @@ -418,11 +418,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
| `properties` | optional | |
| `access` | optional | |

## Chat summaries
## Chat info

**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`.
**Chat info** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat info** includes `last_event_per_type`.

<CodeResponse version="v3.7" type="customer" title={'Sample Chat summary data structure'} json="chatSummary"/>
<CodeResponse version="v3.7" type="customer" title={'Sample Chat info data structure'} json="chatInfo"/>

## Forms

Expand Down
16 changes: 8 additions & 8 deletions src/pages/messaging/customer-chat-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ curl -X POST \

### List Chats

It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) of the chats a customer participated in.
It returns [info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) about the chats a customer participated in.

#### Specifics

Expand All @@ -128,11 +128,11 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s

#### Request

| Parameter | Required | Type | Notes |
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. |
| `page_id` | No | `string` | |
| Parameter | Required | Type | Notes |
| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). The chat info entries are sorted by the creation date of their last thread.|
| `page_id` | No | `string` | |

#### Response

Expand All @@ -141,7 +141,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s
| `total_chats` | `number` | An estimated number. The real number of found chats can slightly differ. |
| `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the next page. |
| `previous_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the previous page. |
| `chats_summary` | `array` | Array of [Chat summary](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) data structures. |
| `chats_info` | `array` | Array of [Chat info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) data structures. |

</Text>

Expand All @@ -164,7 +164,7 @@ curl -X POST \
```json
{
"next_page_id": "MTUxNzM5ODEzMTQ5Ng==",
"chats_summary": [{
"chats_info": [{
"id": "PJ0MRSHTDG",
"last_thread_id": "K600PKZON8",
"last_thread_created_at": "2020-05-08T08:22:21.128420Z",
Expand Down
Loading