Update Chat-Bot imbot.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: an authorized user of the application that registered the chat-bot

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Bot.update.

The imbot.update method updates the data of the chat-bot and its event handlers.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
BOT_ID* `integer`	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* `object`	Data for updating the chat-bot. The structure of the object is described in detail below
CLIENT_ID `string`	This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat-bot

FIELDS Parameter

Name `Type`	Description
CODE `string`	New string code for the bot, unique within Bitrix24
EVENT_HANDLER `string`	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`. If different handlers are needed, do not provide `EVENT_HANDLER`. Set separate URLs in the parameters `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`
EVENT_MESSAGE_ADD `string`	URL for the event handler ONIMBOTMESSAGEADD
EVENT_MESSAGE_UPDATE `string`	URL for the event handler ONIMBOTMESSAGEUPDATE
EVENT_MESSAGE_DELETE `string`	URL for the event handler ONIMBOTMESSAGEDELETE
EVENT_WELCOME_MESSAGE `string`	URL for the event handler ONIMBOTJOINCHAT
EVENT_BOT_DELETE `string`	URL for the event handler ONIMBOTDELETE
PROPERTIES `object`	Properties of the chat-bot profile. The structure of the object is described in detail below

The imbot.update method does not support changing the TYPE and OPENLINE fields.

FIELDS.PROPERTIES Parameter

Name `Type`	Description
NAME `string`	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 `string`	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 `string`	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 `string`	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 `string`	Birthday in the format `YYYY-MM-DD`
WORK_POSITION `string`	Position or description of the chat-bot
PERSONAL_WWW `string`	Link to the website
PERSONAL_GENDER `string`	Gender, acceptable values: `M` or `F`
PERSONAL_PHOTO `file`	Avatar of the chat-bot in Base64 The image size must not exceed the limit of 5000x5000

To update the bot, at least one parameter must be provided: a field in FIELDS or an event handler URL. If all parameters are empty, the method will return an error WRONG_REQUEST.

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 '{"BOT_ID":39,"FIELDS":{"CODE":"newbot_v2","EVENT_HANDLER":"https://example.com/bot/events","PROPERTIES":{"NAME":"UpdatedBot","WORK_POSITION":"Updated description"}},"CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.update

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"FIELDS":{"CODE":"newbot_v2","EVENT_HANDLER":"https://example.com/bot/events","PROPERTIES":{"NAME":"UpdatedBot"}},"auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.update

try {
          const response = await $b24.callMethod('imbot.update', {
            BOT_ID: 39,
            FIELDS: {
              CODE: 'newbot_v2',
              EVENT_HANDLER: 'https://example.com/bot/events',
              PROPERTIES: {
                NAME: 'UpdatedBot',
                WORK_POSITION: 'Updated description',
              },
            },
          });
        
          const { result } = response.getData();
          console.log('Updated:', result);
        } catch (error) {
          console.error('Error updating bot:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.update',
                    [
                        'BOT_ID' => 39,
                        'FIELDS' => [
                            'CODE' => 'newbot_v2',
                            'EVENT_HANDLER' => 'https://example.com/bot/events',
                            'PROPERTIES' => [
                                'NAME' => 'UpdatedBot',
                                'WORK_POSITION' => 'Updated description',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Updated: ' . ($result->data() ? 'true' : 'false');
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error updating bot: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.update',
            {
                BOT_ID: 39,
                FIELDS: {
                    CODE: 'newbot_v2',
                    EVENT_HANDLER: 'https://example.com/bot/events',
                    PROPERTIES: {
                        NAME: 'UpdatedBot',
                        WORK_POSITION: 'Updated description',
                    },
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.update',
            [
                'BOT_ID' => 39,
                'FIELDS' => [
                    'CODE' => 'newbot_v2',
                    'EVENT_HANDLER' => 'https://example.com/bot/events',
                    'PROPERTIES' => [
                        'NAME' => 'UpdatedBot',
                        'WORK_POSITION' => 'Updated description',
                    ],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Updated: ' . ($result['result'] ? 'true' : 'false');
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.update", b24.Params{
        	"BOT_ID": 39,
        	"FIELDS": b24.Params{
        		"CODE":          "newbot_v2",
        		"EVENT_HANDLER": "https://example.com/bot/events",
        		"PROPERTIES": b24.Params{
        			"NAME":          "UpdatedBot",
        			"WORK_POSITION": "Updated description",
        		},
        	},
        	"CLIENT_ID": "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP Code: 200

{
            "result": true,
            "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",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `boolean`	`true` if the bot was updated without error
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "WRONG_REQUEST",
            "error_description": "Update fields can't be empty"
        }

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
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization.	The method was called with session authorization instead of OAuth or webhook
`ACCESS_DENIED`	Access denied! Client ID not specified	Unable to determine the application: `clientId` authorization is missing and `CLIENT_ID` was not provided
`BOT_ID_ERROR`	Bot not found	The bot was not found
`APP_ID_ERROR`	Bot was installed by another REST application	The provided `BOT_ID` belongs to another application
`EVENT_MESSAGE_ADD_ERROR`	Wrong handler URL	An invalid URL for the `EVENT_MESSAGE_ADD` handler was provided
`EVENT_MESSAGE_UPDATE_ERROR`	Wrong handler URL	An invalid URL for the `EVENT_MESSAGE_UPDATE` handler was provided
`EVENT_MESSAGE_DELETE_ERROR`	Wrong handler URL	An invalid URL for the `EVENT_MESSAGE_DELETE` handler was provided
`EVENT_WELCOME_MESSAGE_ERROR`	Wrong handler URL	An invalid URL for the `EVENT_WELCOME_MESSAGE` handler was provided
`EVENT_BOT_DELETE_ERROR`	Wrong handler URL	An invalid URL for the `EVENT_BOT_DELETE` handler was provided
`NAME_ERROR`	Bot name isn't specified	Both fields `NAME` and `LAST_NAME` in `PROPERTIES` were provided as empty
`WRONG_REQUEST`	Update fields can't be empty	No fields or handlers were provided for the update
`WRONG_REQUEST`	Bot can't be updated	The bot cannot be updated

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?

Create a Chatbot

Retrieve a List of Chatbots

Update Chat-Bot imbot.update

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

FIELDS.PROPERTIES ParameterFIELDS.PROPERTIES Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning