Update a Bot imbot.v2.Bot.update

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imbot

Who can execute the method: owner of the registered bot

The method imbot.v2.Bot.update updates the properties of the bot.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId* `integer`	Bot ID
botToken `string`	Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during the chat bot registration
fields* `object`	Fields to be updated. The structure of the object is described below

Parameter fields

Name `Type`	Description
properties `object`	Properties of the bot's profile. Parameter descriptions are below
isHidden `boolean`	Hidden bot. Acceptable values: `true`, `false`
isReactionsEnabled `boolean`	Support for reactions. Acceptable values: `true`, `false`
isSupportOpenline `boolean`	Support for Open Channels. Acceptable values: `true`, `false`
backgroundId `string`	Background of the bot's chat. Pass `null` to reset to the user's background. Available values are in the backgrounds table. An invalid value is normalized to `null`
eventMode `string`	Event delivery mode: `fetch` or `webhook`
webhookUrl `string`	URL of the event handler (applies when `eventMode = webhook`)
botToken `string`	New `botToken` for token rotation. Request authorization is performed with the old token passed at the top level in the `botToken` parameter. An empty string or a string of spaces is ignored. Maximum length is 40 characters. More details in the section BotToken Rotation

Parameter properties

Name `Type`	Description
name `string`	Bot's name
lastName `string`	Bot's last name
workPosition `string`	Bot's position (displayed in the profile)
color `string`	Avatar color, available colors. If specified incorrectly, it is ignored
gender `string`	Gender. Acceptable values: `M`, `F`
avatar `file`	Avatar. Pass a Base64 string without the prefix `data:/;base64,`. How to prepare data: How to upload files

BotToken Rotation

Passing fields.botToken replaces the current bot token with a new one. Request authorization is performed with the old token at the top level; the new token is passed in fields.botToken.

After a successful rotation:

All the bot's subscriptions to events ONIMBOTV2* are re-linked to the new APPLICATION_TOKEN if the bot operates in webhook mode.
The old token instantly loses access to the bot — subsequent requests with it will return the error BOT_OWNERSHIP_ERROR.

In case of a collision (the new token is already linked to another bot), a generic error BOT_TOKEN_ROTATION_FAILED is returned without specifying the reason, to avoid revealing the existence of foreign tokens.

Managing Event Subscriptions

When calling Bot.update, the bot's subscriptions to events ONIMBOTV2* are automatically brought up to date:

Change	Behavior
`webhookUrl` changes (mode remains `webhook`)	The old eight subscriptions to the previous URL are deleted, and eight new ones are created for the new URL. The previous URL stops receiving events
`eventMode`: `webhook` → `fetch`	All eight subscriptions of the bot are deleted. After the transition, events are only available through imbot.v2.Event.get
`eventMode`: `fetch` → `webhook`	Eight subscriptions are created for the specified `webhookUrl`. If there were any "legacy" subscriptions on another URL, they are also deleted before creating new ones
Other fields `properties`, `isHidden`, and others	Subscriptions remain unchanged

OAuth applications with multiple bots: if one application has registered multiple bots under a common clientId, the automatic cleanup of subscriptions when changing webhookUrl or eventMode is skipped to avoid affecting subscriptions of neighboring bots. Webhook-authorized bots with their own botToken do not have this limitation — each of them has its own synthetic APPLICATION_TOKEN.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","fields":{"properties":{"name":"Updated Bot"},"isHidden":true}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.update

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"fields":{"properties":{"name":"Updated Bot"},"isHidden":true},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.update

try {
          const response = await $b24.callMethod('imbot.v2.Bot.update', {
            botId: 456,
            fields: {
              properties: { name: 'Updated Bot' },
              isHidden: true,
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imbot.v2.bot.update(
                bot_id=456,
                fields={
                    "properties": {
                        "name": "Updated Bot",
                    },
                    "isHidden": True,
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Bot.update',
                    [
                        'botId' => 456,
                        'fields' => [
                            'properties' => ['name' => 'Updated Bot'],
                            'isHidden' => true,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }

BX24.callMethod(
            'imbot.v2.Bot.update',
            {
                botId: 456,
                fields: {
                    properties: { name: 'Updated Bot' },
                    isHidden: true,
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Bot.update',
            [
                'botId' => 456,
                'fields' => [
                    'properties' => ['name' => 'Updated Bot'],
                    'isHidden' => true,
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Success';
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.v2.Bot.update", b24.Params{
        	"botId":    456,
        	"botToken": "my_bot_token",
        	"fields": b24.Params{
        		"properties": b24.Params{
        			"name": "Updated Bot",
        		},
        		"isHidden": true,
        	},
        })
        if err != nil {
        	return fmt.Errorf("imbot.v2.Bot.update: %w", err)
        }
        
        // The response shape is shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": true,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "de",
                    "moduleId": "rest",
                    "eventMode": "fetch",
                    "countMessage": 150,
                    "countCommand": 3,
                    "countChat": 12,
                    "countUser": 45
                },
                "users": [
                    {
                        "id": 456,
                        "active": true,
                        "name": "Updated Bot",
                        "bot": true,
                        "type": "bot"
                    }
                ]
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00"
            }
        }

Returned Data

Name `Type`	Description
result `object`	Update result
result.bot `Bot`	Updated bot object in extended format (detailed description)
result.users `User[]`	Array of related users (detailed description)
time `time`	Information about the request execution time

Fields of the Bot Object

Field `Type`	Description
id `integer`	Bot identifier
code `string`	Symbolic code of the bot
type `string`	Type of bot
isHidden `boolean`	Bot is hidden from the contact list
isSupportOpenline `boolean`	Bot supports open channels
isReactionsEnabled `boolean`	Reactions are enabled for bot messages
backgroundId `string\|null`	Chat background ID or `null`
language `string`	Bot's language
moduleId `string`	Module identifier
eventMode `string`	Event delivery mode: `webhook` or `fetch`
countMessage `integer`	Number of messages sent by the bot
countCommand `integer`	Number of registered commands
countChat `integer`	Number of bot chats
countUser `integer`	Number of users who interacted with the bot

Fields of the User Object

Field `Type`	Description
id `integer`	User identifier
active `boolean`	User is active
name `string`	User's first and last name
bot `boolean`	Indicates a bot user
type `string`	User type

A complete description of all object fields can be found on the Objects and Fields page.

Error Handling

HTTP status: 400, 403

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot not found"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` is not specified. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` is not specified
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Bot is registered by another application
`BOT_INVALID_EVENT_MODE`	Invalid event mode	Invalid event delivery mode
`BOT_INVALID_CALLBACK`	Invalid callback URL	Invalid event handler URL
`BOT_AVATAR_INCORRECT_TYPE`	Avatar must be an image	Avatar must be an image (`image/*`)
`BOT_AVATAR_INCORRECT_SIZE`	Avatar exceeds maximum size	Avatar size exceeds maximum (5000×5000 px)
`BOT_TOKEN_ROTATION_FAILED`	Bot token rotation failed	Bot token rotation failed. Generic error code — reason is not disclosed to avoid confirming the existence of foreign tokens

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	The REST API is available only on commercial plans. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Get Information About a Bot

Update a Bot imbot.v2.Bot.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter propertiesParameter properties

BotToken RotationBotToken Rotation

Managing Event SubscriptionsManaging Event Subscriptions

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Bot ObjectFields of the Bot Object

Fields of the User ObjectFields of the User Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning