Skip to content

Commit 9567d58

Browse files
authored
feat(docs): add type property for bots (#1606)
1 parent 12592c2 commit 9567d58

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

src/pages/management/changelog/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Use [**Update an account**](/authorization/global-accounts-api#tag/Accounts/path
4848
### Bots
4949

5050
- The `X-Author-Id` mechanism for bot authorization is no longer supported. The only way to authorize bots is by using bot authorization tokens.
51+
- Bots have a new `type` property.
5152

5253
### Customer bans
5354

src/pages/management/configuration-api/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1271,6 +1271,7 @@ Creates a new bot. To make the bot available for receiving chats or webhooks, us
12711271
| `groups` | No | `object[]` | Groups the Bot belongs to. |
12721272
| `groups[].id` | No | `int` | Group ID; required only when `group`'s included. |
12731273
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in a group; required only when `group`'s included. |
1274+
| `type` | No | `string` | A custom value to categorize or identify the bot. Defaults to `chatbot`. |
12741275
| `work_scheduler` | No | `object` | Work scheduler options to set for the new Bot. See [**Create Agent**](#create-agent) for details. |
12751276
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the Bot's work scheduler should operate. |
12761277
| `owner_client_id`<sup>**2**</sup> | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. |
@@ -1502,6 +1503,7 @@ Updates an existing bot.
15021503
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in the group; required only when `groups` is included. |
15031504
| `default_group_priority`<sup>**1**</sup> | No | `string` | The default routing priority for a group without defined priority. |
15041505
| `job_title` | No | `string` | Bot's job title |
1506+
| `type` | No | `string` | A custom value to categorize or identify the bot. |
15051507
| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. |
15061508
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. |
15071509

src/pages/management/configuration-api/v3.7/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,6 +1425,7 @@ Creates a new bot. To make the bot available for receiving chats or webhooks, us
14251425
| `groups` | No | `object[]` | Groups the Bot belongs to. |
14261426
| `groups[].id` | No | `int` | Group ID; required only when `group`'s included. |
14271427
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in a group; required only when `group`'s included. |
1428+
| `type` | No | `string` | A custom value to categorize or identify the bot. Defaults to `chatbot`.
14281429
| `work_scheduler` | No | `object` | Work scheduler options to set for the new Bot. See [**Create Agent**](#create-agent) for details. |
14291430
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the Bot's work scheduler should operate. |
14301431
| `owner_client_id`<sup>**2**</sup> | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. |
@@ -1656,6 +1657,7 @@ Updates an existing bot.
16561657
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in the group; required only when `groups` is included. |
16571658
| `default_group_priority`<sup>**1**</sup> | No | `string` | The default routing priority for a group without defined priority. |
16581659
| `job_title` | No | `string` | Bot's job title |
1660+
| `type` | No | `string` | A custom value to categorize or identify the bot. |
16591661
| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. |
16601662
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. |
16611663

0 commit comments

Comments
 (0)