openapi: 3.0.3 info: title: Bitrix24 REST BIconnector Chatbots API version: 1.0.0 description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com' contact: name: Bitrix24 Developer Support url: https://apidocs.bitrix24.com/support.html license: name: MIT url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE x-logo: url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg servers: - url: https://{portal}.bitrix24.com/rest description: Your Bitrix24 portal (cloud) variables: portal: default: your-portal description: Subdomain of your Bitrix24 portal - url: https://{host}/rest description: On-Premise Bitrix24 installation variables: host: default: your-bitrix24.example.com description: Host of your on-premise installation security: - AccessToken: [] tags: - name: Chatbots paths: /im.v2: post: summary: Event Formats im.v2 description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Description of all events that the user application receives via [im.v2.Event.get](./event-get.md). The fields of the `message`, `chat`, and `user` objects are described in [{#T}](../../entities.md). **Quick Navigation:** [ONIMV2MESSAGEADD](#onimv2messageadd) | [ONIMV2MESSAGEUPDATE](#onimv2messageupdate) | [ONIMV2MESSAGEDELETE](#onimv2messagedelete) | [ONIMV2REACTIONCHANGE](#onimv2reactionchange) | [ONIMV2JOINCHAT](#onimv2joinchat) operationId: im_v2 tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/events.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: Field: type: string description: '| Type | Description ||' message: type: string description: '| `Message` | The sent message. The description of the object''s fields — Message ||' chat: type: string description: '| `Chat` | The chat where the message was sent. The description of the object''s fields — Chat ||' user: type: string description: '| `User` | The author of the message. The description of the object''s fields — User ||' language: type: string description: '| `string` | The language of the account (e.g., `en`, `de`) ||' messageId: type: string description: '| `integer` | ID of the deleted message ||' reaction: type: string description: '| `string` | Reaction code (e.g., `like`) ||' action: type: string description: '| `string` | Action: `add` — reaction added, `delete` — removed ||' dialogId: type: string description: '| `string` | ID of the dialog (e.g., `chat5`) ||' application/x-www-form-urlencoded: schema: type: object properties: Field: type: string description: '| Type | Description ||' message: type: string description: '| `Message` | The sent message. The description of the object''s fields — Message ||' chat: type: string description: '| `Chat` | The chat where the message was sent. The description of the object''s fields — Chat ||' user: type: string description: '| `User` | The author of the message. The description of the object''s fields — User ||' language: type: string description: '| `string` | The language of the account (e.g., `en`, `de`) ||' messageId: type: string description: '| `integer` | ID of the deleted message ||' reaction: type: string description: '| `string` | Reaction code (e.g., `like`) ||' action: type: string description: '| `string` | Action: `add` — reaction added, `delete` — removed ||' dialogId: type: string description: '| `string` | ID of the dialog (e.g., `chat5`) ||' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] /im.v2.Event.get: post: summary: Get User Events im.v2.Event.get description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.get` retrieves events for the current user in polling mode. To receive events, the user must be previously subscribed via [im.v2.Event.subscribe](./event-subscribe.md). Without a subscription, events are not recorded, and the method will return an empty array. The method uses confirmation via `offset`: pass the `nextOffset` from the previous response to get the next batch of events.' operationId: im_v2_Event_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: offset: type: integer description: '| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||' limit: type: integer description: '| Maximum number of events returned (1–1000). Default is `100` ||' application/x-www-form-urlencoded: schema: type: object properties: offset: type: integer description: '| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||' limit: type: integer description: '| Maximum number of events returned (1–1000). Default is `100` ||' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - im /im.v2.Event.subscribe: post: summary: Subscribe to Events im.v2.Event.subscribe description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.subscribe` subscribes the current user to event logging. After subscribing, message events are recorded in the log and become accessible through [im.v2.Event.get](./event-get.md). The method is idempotent: repeated calls are safe and do not result in an error.' operationId: im_v2_Event_subscribe tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - im /im.v2.Event.unsubscribe: post: summary: Unsubscribing from Events im.v2.Event.unsubscribe description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.unsubscribe` cancels the current user''s subscription to event logging. It stops recording new events in the log. Already recorded events remain accessible through [im.v2.Event.get](./event-get.md) until the retention period expires (24 hours) or until confirmed via `offset`. The method is idempotent: repeated calls are safe and do not result in an error.' operationId: im_v2_Event_unsubscribe tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - im /im.v2.File.download: post: summary: Get Download Link for File im.v2.File.download description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.File.download` returns a link to download a file from the chat. operationId: im_v2_File_download tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: dialogId: type: string description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fileId: type: integer description: '| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||' required: - dialogId - fileId application/x-www-form-urlencoded: schema: type: object properties: dialogId: type: string description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fileId: type: integer description: '| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||' required: - dialogId - fileId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - im /im.v2.File.upload: post: summary: Upload File to Chat im.v2.File.upload description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.File.upload` uploads a file to the chat on behalf of the current user. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.' operationId: im_v2_File_upload tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: dialogId: type: string description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Object with file and message parameters (detailed description) ||' name: type: string description: '| File name with extension ||' content: type: string description: '| File content in Base64 encoding. Maximum size — 100 MB ||' message: type: string description: '| Text of the message sent along with the file ||' required: - dialogId - fields - name - content application/x-www-form-urlencoded: schema: type: object properties: dialogId: type: string description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Object with file and message parameters (detailed description) ||' name: type: string description: '| File name with extension ||' content: type: string description: '| File content in Base64 encoding. Maximum size — 100 MB ||' message: type: string description: '| Text of the message sent along with the file ||' required: - dialogId - fields - name - content responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - im /imbot.bot.list: post: summary: Get the List of Chat Bots imbot.bot.list description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.list](../../chat-bots-v2/imbot.v2/bots/bot-list.md). The method `imbot.bot.list` returns a list of registered chat bots. No parameters required. operationId: imbot_bot_list tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-bot-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||' time: type: string description: '| Information about the request execution time ||' ID: type: integer description: '| Identifier of the chat bot ||' NAME: type: string description: '| Full name of the chat bot ||' CODE: type: string description: '| Code of the chat bot ||' OPENLINE: type: string description: '| Indicator of open line support: `Y` or `N` ||' Code: type: string description: '| Description | Value ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||' time: type: string description: '| Information about the request execution time ||' ID: type: integer description: '| Identifier of the chat bot ||' NAME: type: string description: '| Full name of the chat bot ||' CODE: type: string description: '| Code of the chat bot ||' OPENLINE: type: string description: '| Indicator of open line support: `Y` or `N` ||' Code: type: string description: '| Description | Value ||' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.add: post: summary: Create a chat on behalf of the chat bot imbot.chat.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.add](../../chat-bots-v2/imbot.v2/chats/chat-add.md). The method `imbot.chat.add` creates a chat on behalf of the chat bot. operationId: imbot_chat_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: TYPE: type: string description: '| Type of chat. Possible values:' TITLE: type: string description: '| Title of the chat ||' DESCRIPTION: type: string description: '| Description of the chat ||' COLOR: type: string description: '| Color of the chat for the mobile application. Possible values:' MESSAGE: type: string description: '| Welcome message in the chat ||' USERS: type: array items: {} description: '| Array of chat participants ||' AVATAR: type: string description: '| Avatar of the chat in Base64 format.' ENTITY_TYPE: type: string description: '| Type of the object to bind the chat to an external context ||' ENTITY_ID: type: string description: '| Identifier of the object within `ENTITY_TYPE`.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' application/x-www-form-urlencoded: schema: type: object properties: TYPE: type: string description: '| Type of chat. Possible values:' TITLE: type: string description: '| Title of the chat ||' DESCRIPTION: type: string description: '| Description of the chat ||' COLOR: type: string description: '| Color of the chat for the mobile application. Possible values:' MESSAGE: type: string description: '| Welcome message in the chat ||' USERS: type: array items: {} description: '| Array of chat participants ||' AVATAR: type: string description: '| Avatar of the chat in Base64 format.' ENTITY_TYPE: type: string description: '| Type of the object to bind the chat to an external context ||' ENTITY_ID: type: string description: '| Identifier of the object within `ENTITY_TYPE`.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.get: post: summary: Get Chat ID imbot.chat.get description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md). The method `imbot.chat.get` returns the chat ID. To obtain detailed information about the chat, use the method [imbot.dialog.get](./imbot-dialog-get.md). operationId: imbot_chat_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ENTITY_TYPE: type: string description: '| Type of the external object.' ENTITY_ID: type: string description: '| Identifier of the external object.' required: - ENTITY_TYPE - ENTITY_ID application/x-www-form-urlencoded: schema: type: object properties: ENTITY_TYPE: type: string description: '| Type of the external object.' ENTITY_ID: type: string description: '| Identifier of the external object.' required: - ENTITY_TYPE - ENTITY_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.leave: post: summary: Chat Bot Exit from Specified Chat imbot.chat.leave description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.leave](../../chat-bots-v2/imbot.v2/chats/chat-leave.md). The method `imbot.chat.leave` removes the chat bot from the chat. operationId: imbot_chat_leave tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-leave.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.sendTyping: post: summary: Send Typing Indicator imbot.chat.sendTyping description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.InputAction.notify](../../chat-bots-v2/imbot.v2/ui/chat-input-action-notify.md). The method `imbot.chat.sendTyping` sends a typing indicator to the dialog. The method returns `true` immediately after the command is sent. operationId: imbot_chat_sendTyping tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method.' DIALOG_ID: type: string description: '| The identifier of the object that will receive the message: user or chat.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' required: - DIALOG_ID application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method.' DIALOG_ID: type: string description: '| The identifier of the object that will receive the message: user or chat.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' required: - DIALOG_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.setManager: post: summary: Assign or Revoke Chat Administrator Rights imbot.chat.setManager description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. To assign or revoke administrator rights, use the methods [imbot.v2.Chat.Manager.add](../../chat-bots-v2/imbot.v2/chats/chat-manager-add.md) and [imbot.v2.Chat.Manager.delete](../../chat-bots-v2/imbot.v2/chats/chat-manager-delete.md). The method `imbot.chat.setManager` assigns a chat administrator or revokes administrator rights from a chat participant. operationId: imbot_chat_setManager tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-set-manager.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the user for whom the administrator status is being changed.' IS_MANAGER: type: string description: '| Administrator status. Possible values:' BOT_ID: type: integer description: '| The identifier of the chat bot. The bot identifier can be obtained using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the chat bot registration ||' required: - CHAT_ID - USER_ID application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the user for whom the administrator status is being changed.' IS_MANAGER: type: string description: '| Administrator status. Possible values:' BOT_ID: type: integer description: '| The identifier of the chat bot. The bot identifier can be obtained using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the chat bot registration ||' required: - CHAT_ID - USER_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.setOwner: post: summary: Change Chat Owner via imbot.chat.setOwner description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.setOwner](../../chat-bots-v2/imbot.v2/chats/chat-set-owner.md). The method `imbot.chat.setOwner` changes the owner of the chat. operationId: imbot_chat_setOwner tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the new chat owner.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot identifier using the imbot.bot.list method.' CLIENT_ID: type: string description: '| A technical parameter for scenarios without `clientId` in authorization.' required: - CHAT_ID - USER_ID application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the new chat owner.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot identifier using the imbot.bot.list method.' CLIENT_ID: type: string description: '| A technical parameter for scenarios without `clientId` in authorization.' required: - CHAT_ID - USER_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.updateAvatar: post: summary: Change Chat Avatar imbot.chat.updateAvatar description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateAvatar` updates the chat avatar. operationId: imbot_chat_updateAvatar tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-avatar.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' AVATAR: type: string description: '| Image in Base64 format.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - AVATAR application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' AVATAR: type: string description: '| Image in Base64 format.' BOT_ID: type: integer description: '| Identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - AVATAR responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.updateColor: post: summary: Change Chat Color imbot.chat.updateColor description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateColor` updates the chat color for the mobile application. operationId: imbot_chat_updateColor tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-color.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' COLOR: type: string description: '| The chat color for the mobile application. Possible values:' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - COLOR application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' COLOR: type: string description: '| The chat color for the mobile application. Possible values:' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - COLOR responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.updateTitle: post: summary: Change Chat Title imbot.chat.updateTitle description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateTitle` updates the chat title. operationId: imbot_chat_updateTitle tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-title.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' TITLE: type: string description: '| The new title of the chat.' BOT_ID: type: integer description: '| The identifier of the chatbot. You can obtain the bot ID using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chatbot ||' required: - CHAT_ID - TITLE application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' TITLE: type: string description: '| The new title of the chat.' BOT_ID: type: integer description: '| The identifier of the chatbot. You can obtain the bot ID using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chatbot ||' required: - CHAT_ID - TITLE responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.user.add: post: summary: Add Participants to Chat imbot.chat.user.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.User.add](../../chat-bots-v2/imbot.v2/chats/chat-user-add.md). The method `imbot.chat.user.add` adds users to a chat. operationId: imbot_chat_user_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' USERS: type: array items: {} description: '| Array of user identifiers to be added.' HIDE_HISTORY: type: string description: '| Hide chat history for added users:' BOT_ID: type: integer description: '| Identifier of the chat bot. You can obtain the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' required: - CHAT_ID - USERS application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| Identifier of the chat.' USERS: type: array items: {} description: '| Array of user identifiers to be added.' HIDE_HISTORY: type: string description: '| Hide chat history for added users:' BOT_ID: type: integer description: '| Identifier of the chat bot. You can obtain the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' required: - CHAT_ID - USERS responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.user.delete: post: summary: Exclude Participants from Chat imbot.chat.user.delete description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.User.delete](../../chat-bots-v2/imbot.v2/chats/chat-user-delete.md). The method `imbot.chat.user.delete` removes a user from the chat. operationId: imbot_chat_user_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the user to be removed from the chat.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - USER_ID application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' USER_ID: type: integer description: '| The identifier of the user to be removed from the chat.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID - USER_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.chat.user.list: post: summary: Get the List of Chat Participants imbot.chat.user.list description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.User.list](../../chat-bots-v2/imbot.v2/chats/chat-user-list.md). The method `imbot.chat.user.list` returns a list of identifiers for the chat participants. operationId: imbot_chat_user_list tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID application/x-www-form-urlencoded: schema: type: object properties: CHAT_ID: type: integer description: '| The identifier of the chat.' BOT_ID: type: integer description: '| The identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - CHAT_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.command.answer: post: summary: Send a response to the command imbot.command.answer description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.answer](../../chat-bots-v2/imbot.v2/commands/command-answer.md). The method `imbot.command.answer` publishes a response to a chat bot command. operationId: imbot_command_answer tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-answer.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: COMMAND_ID: type: integer description: '| Command identifier. Required if `COMMAND` is not provided ||' COMMAND: type: string description: '| Command text. Required if `COMMAND_ID` is not provided ||' MESSAGE_ID: type: integer description: '| Identifier of the message to which the response is sent.' MESSAGE: type: string description: '| Response text ||' ATTACH: type: object description: '| Object with an attachment to the message. Minimum format:' KEYBOARD: type: object description: '| Message keyboard. Minimum format:' MENU: type: object description: '| Context menu of the message. Minimum format:' SYSTEM: type: string description: '| Message type:' URL_PREVIEW: type: string description: '| Link transformation into rich links:' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - COMMAND_ID - COMMAND - MESSAGE_ID application/x-www-form-urlencoded: schema: type: object properties: COMMAND_ID: type: integer description: '| Command identifier. Required if `COMMAND` is not provided ||' COMMAND: type: string description: '| Command text. Required if `COMMAND_ID` is not provided ||' MESSAGE_ID: type: integer description: '| Identifier of the message to which the response is sent.' MESSAGE: type: string description: '| Response text ||' ATTACH: type: object description: '| Object with an attachment to the message. Minimum format:' KEYBOARD: type: object description: '| Message keyboard. Minimum format:' MENU: type: object description: '| Context menu of the message. Minimum format:' SYSTEM: type: string description: '| Message type:' URL_PREVIEW: type: string description: '| Link transformation into rich links:' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - COMMAND_ID - COMMAND - MESSAGE_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.command.register: post: summary: Add the imbot.command.register Command description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Command.register](../../chat-bots-v2/imbot.v2/commands/command-register.md). The `imbot.command.register` method registers a command for the chat bot. operationId: imbot_command_register tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-register.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method ||' COMMAND: type: string description: '| The text of the command that the user types in the chat. Latin letters and numbers can be used without spaces and special characters ||' EVENT_COMMAND_ADD: type: string description: '| The URL of the event handler ONIMCOMMANDADD that is triggered when the command is used ||' LANG: type: array items: {} description: '| An array of localizations for the command. The structure is described below ||' COMMON: type: string description: '| Command availability:' HIDDEN: type: string description: '| Command visibility:' EXTRANET_SUPPORT: type: string description: '| Command availability for extranet users:' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' LANGUAGE_ID: type: string description: '| Language identifier, for example `de` or `en` ||' TITLE: type: string description: '| The name of the command in the selected language ||' PARAMS: type: string description: '| Parameter hints for the command in the selected language ||' required: - BOT_ID - COMMAND - EVENT_COMMAND_ADD - LANG - LANGUAGE_ID - TITLE application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method ||' COMMAND: type: string description: '| The text of the command that the user types in the chat. Latin letters and numbers can be used without spaces and special characters ||' EVENT_COMMAND_ADD: type: string description: '| The URL of the event handler ONIMCOMMANDADD that is triggered when the command is used ||' LANG: type: array items: {} description: '| An array of localizations for the command. The structure is described below ||' COMMON: type: string description: '| Command availability:' HIDDEN: type: string description: '| Command visibility:' EXTRANET_SUPPORT: type: string description: '| Command availability for extranet users:' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||' LANGUAGE_ID: type: string description: '| Language identifier, for example `de` or `en` ||' TITLE: type: string description: '| The name of the command in the selected language ||' PARAMS: type: string description: '| Parameter hints for the command in the selected language ||' required: - BOT_ID - COMMAND - EVENT_COMMAND_ADD - LANG - LANGUAGE_ID - TITLE responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.command.unregister: post: summary: Remove the imbot.command.unregister Command description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.unregister](../../chat-bots-v2/imbot.v2/commands/command-unregister.md). The method `imbot.command.unregister` removes a registered command from the chat bot. operationId: imbot_command_unregister tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-unregister.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: COMMAND_ID: type: integer description: '| Identifier of the command to be removed ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - COMMAND_ID application/x-www-form-urlencoded: schema: type: object properties: COMMAND_ID: type: integer description: '| Identifier of the command to be removed ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' required: - COMMAND_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.command.update: post: summary: Update the imbot.command.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.update](../../chat-bots-v2/imbot.v2/commands/command-update.md). The method `imbot.command.update` updates the parameters of a registered chat bot command. operationId: imbot_command_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: COMMAND_ID: type: integer description: '| Identifier of the command to be updated ||' FIELDS: type: object description: '| Object containing fields to update. The structure is described below ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' COMMAND: type: string description: '| Command text ||' EVENT_COMMAND_ADD: type: string description: '| URL of the event handler ONIMCOMMANDADD ||' HIDDEN: type: string description: '| Command visibility:' EXTRANET_SUPPORT: type: string description: '| Availability for extranet users:' LANG: type: array items: {} description: '| Array of command localizations. The structure is described below ||' LANGUAGE_ID: type: string description: '| Language identifier, e.g., `de` or `en` ||' TITLE: type: string description: '| Command title in the selected language ||' PARAMS: type: string description: '| Parameter hint for the command in the selected language ||' required: - COMMAND_ID - FIELDS - LANGUAGE_ID - TITLE application/x-www-form-urlencoded: schema: type: object properties: COMMAND_ID: type: integer description: '| Identifier of the command to be updated ||' FIELDS: type: object description: '| Object containing fields to update. The structure is described below ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||' COMMAND: type: string description: '| Command text ||' EVENT_COMMAND_ADD: type: string description: '| URL of the event handler ONIMCOMMANDADD ||' HIDDEN: type: string description: '| Command visibility:' EXTRANET_SUPPORT: type: string description: '| Availability for extranet users:' LANG: type: array items: {} description: '| Array of command localizations. The structure is described below ||' LANGUAGE_ID: type: string description: '| Language identifier, e.g., `de` or `en` ||' TITLE: type: string description: '| Command title in the selected language ||' PARAMS: type: string description: '| Parameter hint for the command in the selected language ||' required: - COMMAND_ID - FIELDS - LANGUAGE_ID - TITLE responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.dialog.get: post: summary: Get Data About Chat imbot.dialog.get description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md). The method `imbot.dialog.get` returns data about the chat. operationId: imbot_dialog_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-dialog-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DIALOG_ID: type: string description: '| Identifier of the object.' required: - DIALOG_ID application/x-www-form-urlencoded: schema: type: object properties: DIALOG_ID: type: string description: '| Identifier of the object.' required: - DIALOG_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.message.add: post: summary: Send Message imbot.message.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.Message.send](../../chat-bots-v2/imbot.v2/messages/chat-message-send.md). The method `imbot.message.add` sends a message from the chat bot. operationId: imbot_message_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' DIALOG_ID: type: string description: '| The identifier of the object that will receive the message: user or chat.' FROM_USER_ID: type: integer description: '| The identifier of the sender for sending in a private dialog. You can obtain the user ID using user.get and user.search.' TO_USER_ID: type: integer description: '| The identifier of the recipient for sending in a private dialog. You can obtain the user ID using user.get and user.search.' MESSAGE: type: string description: '| The text of the message. The method automatically trims spaces and line breaks from the edges of the message text. ||' ATTACH: type: object KEYBOARD: type: object MENU: type: object SYSTEM: type: string description: '| Indicator of a system message.' URL_PREVIEW: type: string description: '| Controls the display of links: when enabled, the link is shown as a "rich link" with a card.' SKIP_CONNECTOR: type: string description: '| Skip sending the message to external connectors of open channels.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' DIALOG_ID: type: string description: '| The identifier of the object that will receive the message: user or chat.' FROM_USER_ID: type: integer description: '| The identifier of the sender for sending in a private dialog. You can obtain the user ID using user.get and user.search.' TO_USER_ID: type: integer description: '| The identifier of the recipient for sending in a private dialog. You can obtain the user ID using user.get and user.search.' MESSAGE: type: string description: '| The text of the message. The method automatically trims spaces and line breaks from the edges of the message text. ||' ATTACH: type: object KEYBOARD: type: object MENU: type: object SYSTEM: type: string description: '| Indicator of a system message.' URL_PREVIEW: type: string description: '| Controls the display of links: when enabled, the link is shown as a "rich link" with a card.' SKIP_CONNECTOR: type: string description: '| Skip sending the message to external connectors of open channels.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.message.delete: post: summary: Delete Message imbot.message.delete description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.Message.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-delete.md). The method `imbot.message.delete` removes a message from the chat bot. operationId: imbot_message_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' MESSAGE_ID: type: integer description: '| The identifier of the message to be deleted. The value must be greater than `0`.' COMPLETE: type: string description: '| Deletion mode.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' MESSAGE_ID: type: integer description: '| The identifier of the message to be deleted. The value must be greater than `0`.' COMPLETE: type: string description: '| Deletion mode.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.message.like: post: summary: Set "Like" for the message imbot.message.like description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use the methods [imbot.v2.Chat.Message.Reaction.add](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.md) and [imbot.v2.Chat.Message.Reaction.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.md). The method `imbot.message.like` sets or removes the "Like" mark for a message. operationId: imbot_message_like tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-like.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' MESSAGE_ID: type: integer description: '| The identifier of the message in personal dialogs or group chats where the chat bot is present. The value must be greater than `0`.' ACTION: type: string description: '| The action for the message reaction.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list.' MESSAGE_ID: type: integer description: '| The identifier of the message in personal dialogs or group chats where the chat bot is present. The value must be greater than `0`.' ACTION: type: string description: '| The action for the message reaction.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.message.update: post: summary: Update Sent Message imbot.message.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.Message.update](../../chat-bots-v2/imbot.v2/messages/chat-message-update.md). The method `imbot.message.update` modifies a previously sent message from the chat bot. operationId: imbot_message_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. It can be obtained using the imbot.bot.list method.' MESSAGE_ID: type: integer description: '| The identifier of the message to be modified. The value must be greater than `0`.' MESSAGE: type: string description: '| The new text of the message. If an empty value is provided, the message will be deleted.' ATTACH: type: object KEYBOARD: type: object MENU: type: object URL_PREVIEW: type: string description: '| Controls the display of links: when enabled, the link is shown as a "rich link" with a card.' SKIP_CONNECTOR: type: string description: '| Skips sending the message to external connectors of open channels when updating `MESSAGE`.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. It can be obtained using the imbot.bot.list method.' MESSAGE_ID: type: integer description: '| The identifier of the message to be modified. The value must be greater than `0`.' MESSAGE: type: string description: '| The new text of the message. If an empty value is provided, the message will be deleted.' ATTACH: type: object KEYBOARD: type: object MENU: type: object URL_PREVIEW: type: string description: '| Controls the display of links: when enabled, the link is shown as a "rich link" with a card.' SKIP_CONNECTOR: type: string description: '| Skips sending the message to external connectors of open channels when updating `MESSAGE`.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - MESSAGE_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.register: post: summary: Create a Chat-Bot imbot.register description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.register](../../chat-bots-v2/imbot.v2/bots/bot-register.md). The method `imbot.register` registers a chat-bot and binds event handlers of the application. operationId: imbot_register tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-register.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CODE: type: string description: '| The string code of the bot, unique within Bitrix24 ||' TYPE: type: string description: '| The type of the bot.' OPENLINE: type: string description: '| Operation mode with Open Channels.' EVENT_HANDLER: type: string description: '| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`.' EVENT_MESSAGE_ADD: type: string description: '| URL for the event handler ONIMBOTMESSAGEADD ||' EVENT_MESSAGE_UPDATE: type: string description: '| URL for the event handler ONIMBOTMESSAGEUPDATE.' EVENT_MESSAGE_DELETE: type: string description: '| URL for the event handler ONIMBOTMESSAGEDELETE.' EVENT_WELCOME_MESSAGE: type: string description: '| URL for the event handler ONIMBOTJOINCHAT ||' EVENT_BOT_DELETE: type: string description: '| URL for the event handler ONIMBOTDELETE ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Provide a unique CLIENT_ID — this key will be linked to the chat-bot and will be needed for all subsequent calls to imbot* via webhook ||' PROPERTIES: type: object description: '| Properties of the chat-bot profile. The structure of the object is described in detail below ||' NAME: type: string description: '| The name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||' LAST_NAME: type: string description: '| The last name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||' COLOR: type: string description: '| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||' EMAIL: type: string description: '| Email for contacting the chat-bot. The bot is created as a user, so the bot''s email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||' PERSONAL_BIRTHDAY: type: string description: '| Birthday in the format `YYYY-MM-DD` ||' WORK_POSITION: type: string description: '| Position or description of the chat-bot ||' PERSONAL_WWW: type: string description: '| Website link ||' PERSONAL_GENDER: type: string description: '| Gender, allowed values: `M` or `F` ||' PERSONAL_PHOTO: type: string description: '| Avatar of the chat-bot in Base64' required: - CODE - EVENT_MESSAGE_ADD - EVENT_WELCOME_MESSAGE - EVENT_BOT_DELETE - PROPERTIES - NAME - LAST_NAME application/x-www-form-urlencoded: schema: type: object properties: CODE: type: string description: '| The string code of the bot, unique within Bitrix24 ||' TYPE: type: string description: '| The type of the bot.' OPENLINE: type: string description: '| Operation mode with Open Channels.' EVENT_HANDLER: type: string description: '| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`.' EVENT_MESSAGE_ADD: type: string description: '| URL for the event handler ONIMBOTMESSAGEADD ||' EVENT_MESSAGE_UPDATE: type: string description: '| URL for the event handler ONIMBOTMESSAGEUPDATE.' EVENT_MESSAGE_DELETE: type: string description: '| URL for the event handler ONIMBOTMESSAGEDELETE.' EVENT_WELCOME_MESSAGE: type: string description: '| URL for the event handler ONIMBOTJOINCHAT ||' EVENT_BOT_DELETE: type: string description: '| URL for the event handler ONIMBOTDELETE ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Provide a unique CLIENT_ID — this key will be linked to the chat-bot and will be needed for all subsequent calls to imbot* via webhook ||' PROPERTIES: type: object description: '| Properties of the chat-bot profile. The structure of the object is described in detail below ||' NAME: type: string description: '| The name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||' LAST_NAME: type: string description: '| The last name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||' COLOR: type: string description: '| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||' EMAIL: type: string description: '| Email for contacting the chat-bot. The bot is created as a user, so the bot''s email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||' PERSONAL_BIRTHDAY: type: string description: '| Birthday in the format `YYYY-MM-DD` ||' WORK_POSITION: type: string description: '| Position or description of the chat-bot ||' PERSONAL_WWW: type: string description: '| Website link ||' PERSONAL_GENDER: type: string description: '| Gender, allowed values: `M` or `F` ||' PERSONAL_PHOTO: type: string description: '| Avatar of the chat-bot in Base64' required: - CODE - EVENT_MESSAGE_ADD - EVENT_WELCOME_MESSAGE - EVENT_BOT_DELETE - PROPERTIES - NAME - LAST_NAME responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.unregister: post: summary: Unregister Chat Bot imbot.unregister description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.unregister](../../chat-bots-v2/imbot.v2/bots/bot-unregister.md). The method `imbot.unregister` removes a chat bot. When deleting the bot, personal chats with users will also be deleted. operationId: imbot_unregister tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-unregister.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. The value must be greater than `0`.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - BOT_ID application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat bot. The value must be greater than `0`.' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||' required: - BOT_ID responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.update: post: summary: Update Chat-Bot imbot.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.update](../../chat-bots-v2/imbot.v2/bots/bot-update.md). The `imbot.update` method updates the data of the chat-bot and its event handlers. operationId: imbot_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat-bot. You can obtain the identifier using the imbot.bot.list method. The value must be greater than `0` ||' FIELDS: type: object description: '| Data for updating the chat-bot. The structure of the object is described in detail below ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat-bot ||' CODE: type: string description: '| New string code for the bot, unique within Bitrix24 ||' EVENT_HANDLER: type: string description: '| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`.' EVENT_MESSAGE_ADD: type: string description: '| URL for the event handler ONIMBOTMESSAGEADD ||' EVENT_MESSAGE_UPDATE: type: string description: '| URL for the event handler ONIMBOTMESSAGEUPDATE ||' EVENT_MESSAGE_DELETE: type: string description: '| URL for the event handler ONIMBOTMESSAGEDELETE ||' EVENT_WELCOME_MESSAGE: type: string description: '| URL for the event handler ONIMBOTJOINCHAT ||' EVENT_BOT_DELETE: type: string description: '| URL for the event handler ONIMBOTDELETE ||' PROPERTIES: type: object description: '| Properties of the chat-bot profile. The structure of the object is described in detail below ||' NAME: type: string description: '| The name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||' LAST_NAME: type: string description: '| The last name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||' COLOR: type: string description: '| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||' EMAIL: type: string description: '| Email for contacting the chat-bot. The bot is created as a user, so the bot''s email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||' PERSONAL_BIRTHDAY: type: string description: '| Birthday in the format `YYYY-MM-DD` ||' WORK_POSITION: type: string description: '| Position or description of the chat-bot ||' PERSONAL_WWW: type: string description: '| Link to the website ||' PERSONAL_GENDER: type: string description: '| Gender, acceptable values: `M` or `F` ||' PERSONAL_PHOTO: type: string description: '| Avatar of the chat-bot in Base64' required: - BOT_ID - FIELDS application/x-www-form-urlencoded: schema: type: object properties: BOT_ID: type: integer description: '| The identifier of the chat-bot. You can obtain the identifier using the imbot.bot.list method. The value must be greater than `0` ||' FIELDS: type: object description: '| Data for updating the chat-bot. The structure of the object is described in detail below ||' CLIENT_ID: type: string description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat-bot ||' CODE: type: string description: '| New string code for the bot, unique within Bitrix24 ||' EVENT_HANDLER: type: string description: '| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`.' EVENT_MESSAGE_ADD: type: string description: '| URL for the event handler ONIMBOTMESSAGEADD ||' EVENT_MESSAGE_UPDATE: type: string description: '| URL for the event handler ONIMBOTMESSAGEUPDATE ||' EVENT_MESSAGE_DELETE: type: string description: '| URL for the event handler ONIMBOTMESSAGEDELETE ||' EVENT_WELCOME_MESSAGE: type: string description: '| URL for the event handler ONIMBOTJOINCHAT ||' EVENT_BOT_DELETE: type: string description: '| URL for the event handler ONIMBOTDELETE ||' PROPERTIES: type: object description: '| Properties of the chat-bot profile. The structure of the object is described in detail below ||' NAME: type: string description: '| The name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||' LAST_NAME: type: string description: '| The last name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||' COLOR: type: string description: '| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||' EMAIL: type: string description: '| Email for contacting the chat-bot. The bot is created as a user, so the bot''s email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||' PERSONAL_BIRTHDAY: type: string description: '| Birthday in the format `YYYY-MM-DD` ||' WORK_POSITION: type: string description: '| Position or description of the chat-bot ||' PERSONAL_WWW: type: string description: '| Link to the website ||' PERSONAL_GENDER: type: string description: '| Gender, acceptable values: `M` or `F` ||' PERSONAL_PHOTO: type: string description: '| Avatar of the chat-bot in Base64' required: - BOT_ID - FIELDS responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2: post: summary: Change Log for API imbot.v2 description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The change log for API `imbot.v2`: new features, fixes, and changes with breaking changes. Entries are listed from newest to oldest.' operationId: imbot_v2 tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/change-log.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] /imbot.v2.Bot.get: post: summary: Get Information About the Bot imbot.v2.Bot.get description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.get` returns information about the bot. It is used to verify the bot's installation. For the owner application, it returns an extended format (including `moduleId`, `appId`, `eventMode`, and counters). For other applications, it returns a brief format. operationId: imbot_v2_Bot_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID. Required if `code` is not specified ||' code: type: string description: '| Bot code. Required if `botId` is not specified ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID. Required if `code` is not specified ||' code: type: string description: '| Bot code. Required if `botId` is not specified ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Bot.list: post: summary: List of Bots for the imbot.v2.Bot.list Application description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.list` returns a list of bots for the current application in an extended format. operationId: imbot_v2_Bot_list tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' filter: type: object description: '| Filter for results.' limit: type: integer description: '| Number of bots per page. Default is `50` ||' offset: type: integer description: '| Offset for pagination. Default is `0` ||' application/x-www-form-urlencoded: schema: type: object properties: botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' filter: type: object description: '| Filter for results.' limit: type: integer description: '| Number of bots per page. Default is `50` ||' offset: type: integer description: '| Offset for pagination. Default is `0` ||' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Bot.register: post: summary: Register a bot imbot.v2.Bot.register description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.register` registers a new chat bot. The method is idempotent: a repeated call with the same `fields.code` from the same application returns the existing bot without updating the data. To update, use [imbot.v2.Bot.update](./bot-update.md).' operationId: imbot_v2_Bot_register tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| An object with bot parameters. Parameter descriptions are provided below ||' code: type: string description: '| Unique code for the bot within the application ||' botToken: type: string description: '| Unique authorization token for the bot. Required for authorization via webhook, not needed for OAuth.' properties: type: object description: '| Properties of the bot''s profile. Parameter descriptions are provided below ||' type: type: string description: '| Type of the bot. Descriptions of types and their behaviors can be found in Bot Types.' eventMode: type: string description: '| Event delivery mode.' webhookUrl: type: string description: '| URL of the bot''s event handler. Required when `eventMode = webhook` ||' isHidden: type: boolean description: '| Hidden bot. Allowed values: `true`, `false`. Default is `false` ||' isReactionsEnabled: type: boolean description: '| Enable support for reactions. Allowed values: `true`, `false`. Default is `true` ||' isSupportOpenline: type: boolean description: '| Enable support for Open Channels. Allowed values: `true`, `false`. Default is `false` ||' backgroundId: type: string description: '| Background of the bot''s chat. Default is `null` — uses the background from user settings. Available values are in the backgrounds table. An invalid value is normalized to `null` ||' name: type: string description: '| Name of the bot. Displayed in the chat list and dialog header ||' lastName: type: string description: '| Last name of the bot ||' workPosition: type: string description: '| Position of the bot (displayed in the profile) ||' color: type: string description: '| Avatar color, available colors.' gender: type: string description: '| Gender. Allowed values: `M`, `F` ||' avatar: type: string description: '| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`.' ID: type: string description: '| Theme | Color ||' required: - fields - code - properties - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| An object with bot parameters. Parameter descriptions are provided below ||' code: type: string description: '| Unique code for the bot within the application ||' botToken: type: string description: '| Unique authorization token for the bot. Required for authorization via webhook, not needed for OAuth.' properties: type: object description: '| Properties of the bot''s profile. Parameter descriptions are provided below ||' type: type: string description: '| Type of the bot. Descriptions of types and their behaviors can be found in Bot Types.' eventMode: type: string description: '| Event delivery mode.' webhookUrl: type: string description: '| URL of the bot''s event handler. Required when `eventMode = webhook` ||' isHidden: type: boolean description: '| Hidden bot. Allowed values: `true`, `false`. Default is `false` ||' isReactionsEnabled: type: boolean description: '| Enable support for reactions. Allowed values: `true`, `false`. Default is `true` ||' isSupportOpenline: type: boolean description: '| Enable support for Open Channels. Allowed values: `true`, `false`. Default is `false` ||' backgroundId: type: string description: '| Background of the bot''s chat. Default is `null` — uses the background from user settings. Available values are in the backgrounds table. An invalid value is normalized to `null` ||' name: type: string description: '| Name of the bot. Displayed in the chat list and dialog header ||' lastName: type: string description: '| Last name of the bot ||' workPosition: type: string description: '| Position of the bot (displayed in the profile) ||' color: type: string description: '| Avatar color, available colors.' gender: type: string description: '| Gender. Allowed values: `M`, `F` ||' avatar: type: string description: '| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`.' ID: type: string description: '| Theme | Color ||' required: - fields - code - properties - name responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Bot.unregister: post: summary: Remove the Automation rule imbot.v2.Bot.unregister description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.unregister` removes the bot. operationId: imbot_v2_Bot_unregister tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' required: - botId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' required: - botId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Bot.update: post: summary: Update the Automation rule imbot.v2.Bot.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.update` updates the properties of the Automation rule. operationId: imbot_v2_Bot_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| ID of the Automation rule ||' botToken: type: string description: '| Unique authorization token for the Automation rule. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Fields to be updated. The structure of the object is described below ||' properties: type: object description: '| Properties of the Automation rule profile. Description of parameters — below ||' isHidden: type: boolean description: '| Hidden Automation rule. Acceptable values: `true`, `false` ||' isReactionsEnabled: type: boolean description: '| Support for reactions. Acceptable values: `true`, `false` ||' isSupportOpenline: type: boolean description: '| Support for Open Channels. Acceptable values: `true`, `false` ||' backgroundId: type: string description: '| Background of the Automation rule chat. Pass `null` to reset to the user''s background. Available values are in the backgrounds table. Invalid values are normalized to `null` ||' eventMode: type: string description: '| Event delivery mode: `fetch` or `webhook` ||' webhookUrl: type: string description: '| URL of the event handler (applies when `eventMode = webhook`) ||' name: type: string description: '| Name of the Automation rule ||' lastName: type: string description: '| Last name of the Automation rule ||' workPosition: type: string description: '| Position of the Automation rule (displayed in the profile) ||' color: type: string description: '| Avatar color, available colors.' gender: type: string description: '| Gender. Acceptable values: `M`, `F` ||' avatar: type: string description: '| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`.' required: - botId - fields application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| ID of the Automation rule ||' botToken: type: string description: '| Unique authorization token for the Automation rule. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Fields to be updated. The structure of the object is described below ||' properties: type: object description: '| Properties of the Automation rule profile. Description of parameters — below ||' isHidden: type: boolean description: '| Hidden Automation rule. Acceptable values: `true`, `false` ||' isReactionsEnabled: type: boolean description: '| Support for reactions. Acceptable values: `true`, `false` ||' isSupportOpenline: type: boolean description: '| Support for Open Channels. Acceptable values: `true`, `false` ||' backgroundId: type: string description: '| Background of the Automation rule chat. Pass `null` to reset to the user''s background. Available values are in the backgrounds table. Invalid values are normalized to `null` ||' eventMode: type: string description: '| Event delivery mode: `fetch` or `webhook` ||' webhookUrl: type: string description: '| URL of the event handler (applies when `eventMode = webhook`) ||' name: type: string description: '| Name of the Automation rule ||' lastName: type: string description: '| Last name of the Automation rule ||' workPosition: type: string description: '| Position of the Automation rule (displayed in the profile) ||' color: type: string description: '| Avatar color, available colors.' gender: type: string description: '| Gender. Acceptable values: `M`, `F` ||' avatar: type: string description: '| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`.' required: - botId - fields responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.InputAction.notify: post: summary: Send the bot action indicator imbot.v2.Chat.InputAction.notify description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.InputAction.notify` sends a bot action indicator to the chat — for example, "bot is typing". operationId: imbot_v2_Chat_InputAction_notify tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' statusMessageCode: type: string description: '| Action status code. A list of available codes is described below. If not specified, the standard "typing" indicator is displayed ||' duration: type: integer description: '| Duration of the indicator display in seconds (1–600). Default is determined by the server ||' Code: type: string description: '| Displayed Text ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' statusMessageCode: type: string description: '| Action status code. A list of available codes is described below. If not specified, the standard "typing" indicator is displayed ||' duration: type: integer description: '| Duration of the indicator display in seconds (1–600). Default is determined by the server ||' Code: type: string description: '| Displayed Text ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Manager.add: post: summary: Add Chat Managers imbot.v2.Chat.Manager.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Manager.add` adds users to the current list of chat managers. The bot must be the owner of the chat. Users who are not participants in the chat will be ignored without an error. operationId: imbot_v2_Chat_Manager_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to be assigned as managers ||' required: - botId - dialogId - userIds application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to be assigned as managers ||' required: - botId - dialogId - userIds responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Manager.delete: post: summary: Remove Chat Managers imbot.v2.Chat.Manager.delete description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Manager.delete` removes users from the chat manager list. The bot must be the owner of the chat. operationId: imbot_v2_Chat_Manager_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to remove the manager role ||' required: - botId - dialogId - userIds application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to remove the manager role ||' required: - botId - dialogId - userIds responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.Reaction.add: post: summary: Add Reaction to Message imbot.v2.Chat.Message.Reaction.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.Reaction.add` adds a bot reaction to a message. operationId: imbot_v2_Chat_Message_Reaction_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' reaction: type: string description: '| Reaction code. The list of available codes is described below ||' Code: type: string description: '| Description ||' required: - botId - messageId - reaction application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' reaction: type: string description: '| Reaction code. The list of available codes is described below ||' Code: type: string description: '| Description ||' required: - botId - messageId - reaction responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.Reaction.delete: post: summary: Remove Reaction from Message imbot.v2.Chat.Message.Reaction.delete description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.Reaction.delete` removes the bot's reaction from a message. operationId: imbot_v2_Chat_Message_Reaction_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' reaction: type: string description: '| Reaction code to be removed. List of available codes: imbot.v2.Chat.Message.Reaction.add ||' required: - botId - messageId - reaction application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' reaction: type: string description: '| Reaction code to be removed. List of available codes: imbot.v2.Chat.Message.Reaction.add ||' required: - botId - messageId - reaction responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.delete: post: summary: Delete Message imbot.v2.Chat.Message.delete description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.delete` removes a message. The bot can delete its own messages. If the bot is an administrator of the chat, it can delete any message. Messages sent with the parameter `system: true` have `authorId = 0`. The bot will not be able to delete such a message unless it is an administrator of the chat.' operationId: imbot_v2_Chat_Message_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the message to be deleted ||' complete: type: boolean description: '| Complete removal from the database. Acceptable values: `true`, `false`. Default is `false` (soft delete) ||' required: - botId - messageId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the message to be deleted ||' complete: type: boolean description: '| Complete removal from the database. Acceptable values: `true`, `false`. Default is `false` (soft delete) ||' required: - botId - messageId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.get: post: summary: Get Message imbot.v2.Chat.Message.get description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.get` returns a message by its ID. Typical use-case: the bot received an event with `replyId` and wants to read the original message. The method is available only for `supervisor` and `personal` type bots. For more details, see [Bot Types](../../../index.md#bot-types).' operationId: imbot_v2_Chat_Message_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' required: - botId - messageId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| Message ID ||' required: - botId - messageId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.getContext: post: summary: Get Context of Message imbot.v2.Chat.Message.getContext description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.getContext` returns a window of messages surrounding the specified one. It is used for analyzing the dialogue history. The method is only available for `supervisor` and `personal` type bots. For more details, see [Bot Types](../../../index.md#bot-types). operationId: imbot_v2_Chat_Message_getContext tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the central message ||' range: type: integer description: '| Number of messages on each side of the central one (1–50). Default is `50` ||' required: - botId - messageId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the central message ||' range: type: integer description: '| Number of messages on each side of the central one (1–50). Default is `50` ||' required: - botId - messageId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.read: post: summary: Mark Messages as Read imbot.v2.Chat.Message.read description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.read` marks messages as read on behalf of the bot. It marks all messages up to and including the specified one as read. If `messageId` is not specified, it marks all messages in the chat as read. operationId: imbot_v2_Chat_Message_read tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' messageId: type: integer description: '| Read all messages up to and including this one. If not specified, it will read all messages in the chat ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' messageId: type: integer description: '| Read all messages up to and including this one. If not specified, it will read all messages in the chat ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.send: post: summary: Send Message imbot.v2.Chat.Message.send description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.send` sends a message on behalf of the bot to the specified dialog. operationId: imbot_v2_Chat_Message_send tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Message content. The structure of the object is described below ||' message: type: string description: '| Message text. Maximum length — 20,000 characters. If exceeded, the text is truncated with ` (...)` added ||' attach: type: array items: {} description: '| Attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| Keyboard with buttons. More details: Working with Keyboards ||' system: type: boolean description: '| System message. Allowed values: `true`, `false`. Default is `false` ||' urlPreview: type: boolean description: '| Show link previews. Allowed values: `true`, `false`. Default is `true` ||' replyId: type: integer description: '| ID of the message being replied to by the bot ||' templateId: type: string description: '| UUID of the message template ||' forwardIds: type: object description: '| Messages to forward. Format: `{uuid: messageId}`, where `uuid` is an arbitrary UUID string as the key, `messageId` is the ID of the original message. In the response, `uuidMap` will return `{uuid: newMessageId}`.' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Message content. The structure of the object is described below ||' message: type: string description: '| Message text. Maximum length — 20,000 characters. If exceeded, the text is truncated with ` (...)` added ||' attach: type: array items: {} description: '| Attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| Keyboard with buttons. More details: Working with Keyboards ||' system: type: boolean description: '| System message. Allowed values: `true`, `false`. Default is `false` ||' urlPreview: type: boolean description: '| Show link previews. Allowed values: `true`, `false`. Default is `true` ||' replyId: type: integer description: '| ID of the message being replied to by the bot ||' templateId: type: string description: '| UUID of the message template ||' forwardIds: type: object description: '| Messages to forward. Format: `{uuid: messageId}`, where `uuid` is an arbitrary UUID string as the key, `messageId` is the ID of the original message. In the response, `uuidMap` will return `{uuid: newMessageId}`.' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.Message.update: post: summary: Update Message imbot.v2.Chat.Message.update description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.update` updates a bot''s message. A bot can only update its own messages. Messages sent with the parameter `system: true` cannot be updated—they have `authorId = 0` and do not belong to the bot in terms of access permissions.' operationId: imbot_v2_Chat_Message_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the message to be updated ||' fields: type: object description: '| Fields of the message to be updated. The structure of the object is described below ||' message: type: string description: '| New text of the message. Maximum length—20,000 characters ||' attach: type: array items: {} description: '| New attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| New keyboard. More details: Working with keyboards. To remove the keyboard, pass `"N"` ||' urlPreview: type: string description: '| Show link previews. Acceptable values: `Y`, `N`. Default is `Y` ||' required: - botId - messageId - fields application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' messageId: type: integer description: '| ID of the message to be updated ||' fields: type: object description: '| Fields of the message to be updated. The structure of the object is described below ||' message: type: string description: '| New text of the message. Maximum length—20,000 characters ||' attach: type: array items: {} description: '| New attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| New keyboard. More details: Working with keyboards. To remove the keyboard, pass `"N"` ||' urlPreview: type: string description: '| Show link previews. Acceptable values: `Y`, `N`. Default is `Y` ||' required: - botId - messageId - fields responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.TextField.enabled: post: summary: Managing the Text Input Field imbot.v2.Chat.TextField.enabled description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.TextField.enabled` enables or disables the text input field in the chat. This method works in both group and personal chats with the bot. Access is verified based on the bot's membership in the chat, so `ACCESS_DENIED` is returned only if the bot is not a participant in the specified dialogue. operationId: imbot_v2_Chat_TextField_enabled tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialogue ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' enabled: type: boolean description: '| Control the input field: `true` — enable, `false` — disable. Default is `true` ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialogue ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' enabled: type: boolean description: '| Control the input field: `true` — enable, `false` — disable. Default is `true` ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.User.add: post: summary: Add Participants to Chat imbot.v2.Chat.User.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.add` adds participants to a chat. The bot must be an administrator of the chat. Non-existent or inactive users will be ignored without an error. operationId: imbot_v2_Chat_User_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to add ||' required: - botId - dialogId - userIds application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userIds: type: string description: '| Array of user IDs to add ||' required: - botId - dialogId - userIds responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.User.delete: post: summary: Remove a Participant from the Chat imbot.v2.Chat.User.delete description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.delete` removes a participant from the chat. The bot must be an administrator of the chat. If the user is not a participant in the chat, the method will return `true` (idempotent behavior). operationId: imbot_v2_Chat_User_delete tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userId: type: integer description: '| User ID to be removed ||' required: - botId - dialogId - userId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userId: type: integer description: '| User ID to be removed ||' required: - botId - dialogId - userId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.User.list: post: summary: List of Chat Participants imbot.v2.Chat.User.list description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.list` returns a list of chat participants. operationId: imbot_v2_Chat_User_list tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' order: type: object description: '| Sorting.' limit: type: integer description: '| Number of records (1–200). Default is `50` ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' order: type: object description: '| Sorting.' limit: type: integer description: '| Number of records (1–200). Default is `50` ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.add: post: summary: Create a Group Chat imbot.v2.Chat.add description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.add` creates a new group chat on behalf of the bot. If the owner is not specified, the bot becomes the owner. operationId: imbot_v2_Chat_add tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Properties of the chat being created. The structure of the object is described below ||' title: type: string description: '| Chat title ||' description: type: string description: '| Chat description ||' color: type: string description: '| Chat color — available colors.' avatar: type: string description: '| Chat avatar in Base64 format ||' userIds: type: string description: '| Array of participant IDs ||' ownerId: type: integer description: '| ID of the chat owner. If not specified, the bot becomes the owner ||' message: type: string description: '| First message in the chat ||' Code: type: string description: '| HEX ||' required: - botId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Properties of the chat being created. The structure of the object is described below ||' title: type: string description: '| Chat title ||' description: type: string description: '| Chat description ||' color: type: string description: '| Chat color — available colors.' avatar: type: string description: '| Chat avatar in Base64 format ||' userIds: type: string description: '| Array of participant IDs ||' ownerId: type: integer description: '| ID of the chat owner. If not specified, the bot becomes the owner ||' message: type: string description: '| First message in the chat ||' Code: type: string description: '| HEX ||' required: - botId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.get: post: summary: Get Information About the Chat imbot.v2.Chat.get description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.get` returns information about the chat. The bot must be a participant in the chat. operationId: imbot_v2_Chat_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.leave: post: summary: Leave Chat imbot.v2.Chat.leave description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.leave` removes the bot from the chat. operationId: imbot_v2_Chat_leave tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' required: - botId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' required: - botId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.setOwner: post: summary: Assign Chat Owner imbot.v2.Chat.setOwner description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.setOwner` transfers ownership of the chat to another user. Only the current owner of the chat can transfer ownership. operationId: imbot_v2_Chat_setOwner tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userId: type: integer description: '| ID of the new chat owner ||' required: - botId - dialogId - userId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}` ||' userId: type: integer description: '| ID of the new chat owner ||' required: - botId - dialogId - userId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Chat.update: post: summary: Update Chat Properties imbot.v2.Chat.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.update` updates the properties of a chat. It combines the update of the title, description, color, and avatar in a single call. operationId: imbot_v2_Chat_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Properties of the chat to be updated. The structure of the object is described below ||' title: type: string description: '| New chat title ||' description: type: string description: '| New chat description ||' color: type: string description: '| Chat color — available colors ||' avatar: type: string description: '| New chat avatar in Base64 format ||' Code: type: string description: '| HEX ||' required: - botId - dialogId - fields application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Properties of the chat to be updated. The structure of the object is described below ||' title: type: string description: '| New chat title ||' description: type: string description: '| New chat description ||' color: type: string description: '| Chat color — available colors ||' avatar: type: string description: '| New chat avatar in Base64 format ||' Code: type: string description: '| HEX ||' required: - botId - dialogId - fields responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Command.answer: post: summary: Responding to the imbot.v2.Command.answer Command description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `imbot.v2.Command.answer` method sends a bot's response to a slash command invocation. The bot can respond in the chat from which the command originated, even if the bot is not a participant in that chat. Access is granted temporarily based on the command token — `messageId` + `commandId`. If the bot is not a participant in the chat, the message is sent as a system message indicating the bot's name. operationId: imbot_v2_Command_answer tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' messageId: type: integer description: '| Message ID with the command ||' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Fields of the response message. The structure of the object is described below ||' message: type: string description: '| Response text. Maximum length — 20,000 characters ||' attach: type: array items: {} description: '| Attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| Keyboard. More details: Working with keyboards ||' system: type: boolean description: '| System message. Allowed values: `true`, `false`. Default is `false` ||' urlPreview: type: boolean description: '| Show link previews. Allowed values: `true`, `false`. Default is `true` ||' required: - botId - commandId - messageId - dialogId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' messageId: type: integer description: '| Message ID with the command ||' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| Fields of the response message. The structure of the object is described below ||' message: type: string description: '| Response text. Maximum length — 20,000 characters ||' attach: type: array items: {} description: '| Attachments. More details: How to use attachments ||' keyboard: type: array items: {} description: '| Keyboard. More details: Working with keyboards ||' system: type: boolean description: '| System message. Allowed values: `true`, `false`. Default is `false` ||' urlPreview: type: boolean description: '| Show link previews. Allowed values: `true`, `false`. Default is `true` ||' required: - botId - commandId - messageId - dialogId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Command.list: post: summary: Get the List of Commands imbot.v2.Command.list description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.list` returns a list of all commands of the bot. operationId: imbot_v2_Command_list tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' required: - botId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' required: - botId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Command.register: post: summary: Register the Team imbot.v2.Command.register description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.register` registers a bot''s slash command. The method is idempotent: a repeated call with the same `command` for the same bot from the same application returns the existing command without updating the data. To update, use [imbot.v2.Command.update](./command-update.md). The method call format has changed: command parameters are now passed in the `fields` object. The old flat format will be supported until 30.09.2026. For more details, see [API Change Log for imbot.v2](../../change-log.md#command-register-fields).' operationId: imbot_v2_Command_register tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Object with command parameters (detailed description) ||' command: type: string description: '| Command without the `/` symbol. For example: `help` ||' title: type: object description: '| Title of the command in different languages. An object `{langCode: text}`, where `langCode` is a two-letter lowercase language code: `en`, `de`, etc.' params: type: object description: '| Description of command parameters in different languages. An object `{langCode: text}`, similar to `title`. Displayed as a hint next to the command ||' common: type: boolean description: '| Common command. Acceptable values: `true`, `false`. Default is `false`. For more details, see Common and Local Commands ||' hidden: type: boolean description: '| Hidden command. Acceptable values: `true`, `false`. Default is `false` ||' extranetSupport: type: boolean description: '| Extranet support. Acceptable values: `true`, `false`. Default is `false` ||' required: - botId - fields - command application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fields: type: object description: '| Object with command parameters (detailed description) ||' command: type: string description: '| Command without the `/` symbol. For example: `help` ||' title: type: object description: '| Title of the command in different languages. An object `{langCode: text}`, where `langCode` is a two-letter lowercase language code: `en`, `de`, etc.' params: type: object description: '| Description of command parameters in different languages. An object `{langCode: text}`, similar to `title`. Displayed as a hint next to the command ||' common: type: boolean description: '| Common command. Acceptable values: `true`, `false`. Default is `false`. For more details, see Common and Local Commands ||' hidden: type: boolean description: '| Hidden command. Acceptable values: `true`, `false`. Default is `false` ||' extranetSupport: type: boolean description: '| Extranet support. Acceptable values: `true`, `false`. Default is `false` ||' required: - botId - fields - command responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Command.unregister: post: summary: Remove the imbot.v2.Command.unregister Command description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.unregister` removes a bot's slash command. operationId: imbot_v2_Command_unregister tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' required: - botId - commandId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' required: - botId - commandId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Command.update: post: summary: Update the imbot.v2.Command.update description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.update` updates the bot's slash command. operationId: imbot_v2_Command_update tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' fields: type: object description: '| Fields of the command to be updated. The structure of the object is described below ||' command: type: string description: '| New command (without `/`) ||' title: type: object description: '| Title of the command in different languages:' params: type: object description: '| Description of parameters in different languages. Similar to `title`, applies only to those languages provided in `title` ||' common: type: string description: '| Common command. Allowed values: `Y`, `N` ||' hidden: type: string description: '| Hidden command. Allowed values: `Y`, `N` ||' extranetSupport: type: string description: '| Extranet support. Allowed values: `Y`, `N` ||' required: - botId - commandId - fields application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' commandId: type: integer description: '| Command ID ||' fields: type: object description: '| Fields of the command to be updated. The structure of the object is described below ||' command: type: string description: '| New command (without `/`) ||' title: type: object description: '| Title of the command in different languages:' params: type: object description: '| Description of parameters in different languages. Similar to `title`, applies only to those languages provided in `title` ||' common: type: string description: '| Common command. Allowed values: `Y`, `N` ||' hidden: type: string description: '| Hidden command. Allowed values: `Y`, `N` ||' extranetSupport: type: string description: '| Extranet support. Allowed values: `Y`, `N` ||' required: - botId - commandId - fields responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Event.get: post: summary: Get Events from imbot.v2.Event.get description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Event.get` retrieves events for the bot in polling agent mode. It is used for bots with `eventMode: "fetch"`. The method confirms the receipt of events with IDs less than the provided `offset`. On the next call, only new events starting from the confirmed ones are returned. Only one application—the one that registered the bot—can receive events for a specific bot. If multiple independent agents are needed, register a separate bot for each.' operationId: imbot_v2_Event_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/events/event-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' offset: type: integer description: '| Confirms all events with IDs less than the specified value. Not passed on the first call ||' limit: type: integer description: '| Maximum number of events returned (1–1000). Default is `100` ||' withUserEvents: type: boolean description: '| Include user events (`ONIMV2*`) in the response along with bot events. Default is `false`. More details — below ||' required: - botId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' offset: type: integer description: '| Confirms all events with IDs less than the specified value. Not passed on the first call ||' limit: type: integer description: '| Maximum number of events returned (1–1000). Default is `100` ||' withUserEvents: type: boolean description: '| Include user events (`ONIMV2*`) in the response along with bot events. Default is `false`. More details — below ||' required: - botId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.File.download: post: summary: Get Download Link for imbot.v2.File.download description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.File.download` returns a link to download a file from the chat. operationId: imbot_v2_File_download tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fileId: type: integer description: '| File ID on Drive. Can be obtained from the response of the imbot.v2.File.upload method ||' required: - botId - fileId application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' fileId: type: integer description: '| File ID on Drive. Can be obtained from the response of the imbot.v2.File.upload method ||' required: - botId - fileId responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.File.upload: post: summary: Upload File to Chat imbot.v2.File.upload description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.File.upload` uploads a file to the chat on behalf of the bot. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.' operationId: imbot_v2_File_upload tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| File and message data. The structure is described below ||' name: type: string description: '| File name with extension ||' content: type: string description: '| File content in Base64 encoding. Maximum size — 100 MB ||' message: type: string description: '| Text message sent along with the file ||' required: - botId - dialogId - fields - name - content application/x-www-form-urlencoded: schema: type: object properties: botId: type: integer description: '| Bot ID ||' botToken: type: string description: '| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.' dialogId: type: string description: '| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||' fields: type: object description: '| File and message data. The structure is described below ||' name: type: string description: '| File name with extension ||' content: type: string description: '| File content in Base64 encoding. Maximum size — 100 MB ||' message: type: string description: '| Text message sent along with the file ||' required: - botId - dialogId - fields - name - content responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot /imbot.v2.Revision.get: post: summary: Get API Revisions imbot.v2.Revision.get description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Revision.get` returns the revision numbers of the REST API and client protocols of the messenger. It is used to check compatibility: which methods and features are supported by a specific Bitrix24.' operationId: imbot_v2_Revision_get tags: - Chatbots externalDocs: url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/revision-get.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BitrixResponse' 4XX: description: Request error (400, 401, 403) content: application/json: schema: $ref: '#/components/schemas/BitrixError' security: - AccessToken: [] - OAuth2: - imbot components: schemas: BitrixError: type: object description: Bitrix24 REST API error response required: - error - error_description properties: error: type: string description: Error code example: ACCESS_DENIED error_description: type: string description: Human-readable error description example: Access denied. BitrixTime: type: object description: Request execution time information properties: start: type: number format: double finish: type: number format: double duration: type: number format: double processing: type: number format: double date_start: type: string format: date-time date_finish: type: string format: date-time operating_reset_at: type: integer operating: type: number format: double BitrixResponse: type: object description: Standard Bitrix24 REST API response properties: result: description: Method execution result total: type: integer description: Total number of records (for list methods) next: type: integer description: Next offset for pagination time: $ref: '#/components/schemas/BitrixTime' securitySchemes: AccessToken: type: apiKey in: query name: auth description: OAuth 2.0 access_token or incoming webhook token OAuth2: type: oauth2 description: OAuth 2.0 authorization flows: authorizationCode: authorizationUrl: https://oauth.bitrix.info/oauth/authorize/ tokenUrl: https://oauth.bitrix.info/oauth/token/ scopes: crm: CRM — leads, deals, contacts, companies, smart processes task: Tasks and projects disk: Drive — files and folders im: Chats and notifications imbot: Chatbots imopenlines: Open Lines — messenger connectors telephony: Telephony sale: E-Commerce — orders, shipments catalog: Trade Catalog — products, prices calendar: Calendar bizproc: Business processes and robots user: Users department: Company structure timeman: Time tracking landing: Sites and landing pages pay_system: Payment systems cashbox: Online cash registers delivery: Delivery services documentgenerator: Document generator lists: Universal lists entity: Data storage log: News feed sonet_group: Workgroups and projects mailservice: Mail services messageservice: Message providers (SMS) biconnector: BIconnector — BI analytics ai_admin: CoPilot / AI sign.b2e: Signature — e-document signing vote: Polls and voting booking: Online booking userconsent: User consent agreements userfieldconfig: Custom field settings basic: Basic access placement: Widget placements rpa: Robots process automation sonet: Social network intranet: Intranet socialnetwork: Social network workgroups: Workgroups salescenter: Sales center main: Main module imconnector: IM connector user.userfield: User custom fields user_basic: Basic user access userfieldconfig, module scope: Custom field config externalDocs: description: Official Bitrix24 REST API Documentation url: https://apidocs.bitrix24.com