Update Chatbot imbot.update

Scope: imbot

Who can execute the method: an authorized user of the application that registered the chatbot

The method imbot.update updates the chatbot's data and its event handlers.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
BOT_ID* `integer`	The identifier of the chatbot. You can obtain the identifier using the imbot.bot.list method. The value must be greater than `0`
FIELDS* `object`	Data for updating the chatbot. 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 chatbot registration

FIELDS Parameter

Name `Type`	Description
CODE `string`	The 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 pass `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 chatbot profile. The structure of the object is described in detail below

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

FIELDS.PROPERTIES Parameter

Name `Type`	Description
NAME `string`	The name of the chatbot. If both values are provided: `NAME` and `LAST_NAME`, they must not be empty at the same time
LAST_NAME `string`	The last name of the chatbot. If both values are provided: `NAME` and `LAST_NAME`, they must not be empty at the same time
COLOR `string`	The color of the chatbot 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 chatbot. 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 chatbot
PERSONAL_WWW `string`	Link to the website
PERSONAL_GENDER `string`	Gender, acceptable values: `M` or `F`
PERSONAL_PHOTO `file`	Avatar of the chatbot in Base64 format The image size must not exceed the limit of 5000x5000

To update the bot, pass at least one parameter: 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');
        }

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 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
`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: missing `clientId` authorization and `CLIENT_ID` not provided
`BOT_ID_ERROR`	Bot not found	Bot 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	Invalid URL for the `EVENT_MESSAGE_ADD` handler
`EVENT_MESSAGE_UPDATE_ERROR`	Wrong handler URL	Invalid URL for the `EVENT_MESSAGE_UPDATE` handler
`EVENT_MESSAGE_DELETE_ERROR`	Wrong handler URL	Invalid URL for the `EVENT_MESSAGE_DELETE` handler
`EVENT_WELCOME_MESSAGE_ERROR`	Wrong handler URL	Invalid URL for the `EVENT_WELCOME_MESSAGE` handler
`EVENT_BOT_DELETE_ERROR`	Wrong handler URL	Invalid URL for the `EVENT_BOT_DELETE` handler
`NAME_ERROR`	Bot name isn't specified	Both fields `NAME` and `LAST_NAME` in `PROPERTIES` are empty
`WRONG_REQUEST`	Update fields can't be empty	No fields or handlers provided for the update
`WRONG_REQUEST`	Bot can't be updated	The bot cannot be updated

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create a Chatbot

Get a List of Chatbots

Update Chatbot 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