Update the Automation rule 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 Automation rule

The method imbot.v2.Bot.update updates the properties of the Automation rule.

Method Parameters

Required parameters are marked with *

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

Parameter fields

Name `Type`	Description
properties `object`	Properties of the Automation rule profile. Description of parameters — below
isHidden `boolean`	Hidden Automation rule. 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 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 `string`	Event delivery mode: `fetch` or `webhook`
webhookUrl `string`	URL of the event handler (applies when `eventMode = webhook`)

Parameter properties

Name `Type`	Description
name `string`	Name of the Automation rule
lastName `string`	Last name of the Automation rule
workPosition `string`	Position of the Automation rule (displayed in the profile)
color `string`	Avatar color, available colors. If specified incorrectly — 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

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

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);
        }

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';
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": true,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "de",
                    "moduleId": "rest",
                    "appId": "local.67890abcdef12.34567890",
                    "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`	Result of the update
result.bot `Bot`	Updated Automation rule 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`	Identifier of the Automation rule
code `string`	Symbolic code of the Automation rule
type `string`	Type of the Automation rule
isHidden `boolean`	Automation rule is hidden from the contact list
isSupportOpenline `boolean`	Automation rule supports Open Channels
isReactionsEnabled `boolean`	Reactions are enabled for messages from the Automation rule
backgroundId [`string	null`](../../../../data-types.md)	ID of the chat background or `null`
language `string`	Language of the Automation rule
moduleId `string`	Module identifier
appId `string`	ID of the application that registered the Automation rule
eventMode `string`	Event delivery mode: `webhook` or `fetch`
countMessage `integer`	Number of messages sent by the Automation rule
countCommand `integer`	Number of registered commands
countChat `integer`	Number of chats of the Automation rule
countUser `integer`	Number of users who interacted with the Automation rule

Fields of the User Object

Field `Type`	Description
id `integer`	Identifier of the user
active `boolean`	User is active
name `string`	Name and surname of the user
bot `boolean`	Indicates if the user is a bot
type `string`	Type of the user

Complete description of all object fields is available 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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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	Automation rule not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Automation rule 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 the maximum (5000×5000 px)

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Get Information About a Bot

Update the Automation rule imbot.v2.Bot.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter propertiesParameter properties

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