Register a bot imbot.v2.Bot.register

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: authorized user

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.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
fields* `object`	An object with bot parameters. Parameter descriptions are provided below

Parameter fields

Name `Type`	Description
code* `string`	Unique code for the bot within the application
botToken `string`	Unique authorization token for the bot. Required for authorization via webhook, not needed for OAuth. Pass the unique botToken — this key will be tied to the chat bot and will be required for all subsequent calls to imbot.v2* via webhook
properties* `object`	Properties of the bot's profile. Parameter descriptions are provided below
type `string`	Type of the bot. Descriptions of types and their behaviors can be found in Bot Types. Default value: `bot`
eventMode `string`	Event delivery mode. Allowed values: `fetch` — the bot retrieves events via imbot.v2.Event.get `webhook` — events are sent via POST request to `webhookUrl` Default value: `fetch`
webhookUrl `string`	URL of the bot's event handler. Required when `eventMode = webhook`
isHidden `boolean`	Hidden bot. Allowed values: `true`, `false`. Default is `false`
isReactionsEnabled `boolean`	Enable support for reactions. Allowed values: `true`, `false`. Default is `true`
isSupportOpenline `boolean`	Enable support for Open Channels. Allowed values: `true`, `false`. Default is `false`
backgroundId `string`	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`

Parameter properties

Name `Type`	Description
name* `string`	Name of the bot. Displayed in the chat list and dialog header
lastName `string`	Last name of the bot
workPosition `string`	Position of the bot (displayed in the profile)
color `string`	Avatar color, available colors. If not specified, it is assigned automatically
gender `string`	Gender. Allowed values: `M`, `F`
avatar `file`	Avatar. Pass a Base64 string without the prefix `data:/;base64,`. How to prepare the data: How to upload files

Available Backgrounds

ID	Theme	Color
`azure`	dark	Blue
`mint`	dark	Mint
`steel`	dark	Steel
`slate`	dark	Slate
`teal`	dark	Teal
`cornflower`	dark	Cornflower
`sky`	light	Sky
`peach`	light	Peach
`frost`	light	Frost

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 '{
            "fields": {
              "code": "support_bot",
              "botToken": "my_bot_token",
              "properties": {"name": "Support Bot", "workPosition": "AI Assistant"},
              "type": "bot",
              "eventMode": "fetch"
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.register

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "code": "support_bot",
              "properties": {"name": "Support Bot", "workPosition": "AI Assistant"},
              "type": "bot",
              "eventMode": "fetch"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.register

try {
          const response = await $b24.callMethod('imbot.v2.Bot.register', {
            fields: {
              code: 'support_bot',
              properties: {
                name: 'Support Bot',
                workPosition: 'AI Assistant',
              },
              type: 'bot',
              eventMode: 'fetch',
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Bot.register',
                    [
                        'fields' => [
                            'code' => 'support_bot',
                            'properties' => [
                                'name' => 'Support Bot',
                                'workPosition' => 'AI Assistant',
                            ],
                            'type' => 'bot',
                            'eventMode' => 'fetch',
                        ],
                    ]
                );
        
            $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.register',
            {
                fields: {
                    code: 'support_bot',
                    properties: {
                        name: 'Support Bot',
                        workPosition: 'AI Assistant',
                    },
                    type: 'bot',
                    eventMode: 'fetch',
                },
            },
            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.register',
            [
                'fields' => [
                    'code' => 'support_bot',
                    'properties' => [
                        'name' => 'Support Bot',
                        'workPosition' => 'AI Assistant',
                    ],
                    'type' => 'bot',
                    'eventMode' => 'fetch',
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Bot ID: ' . $result['result']['bot']['id'];
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": false,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "en",
                    "moduleId": "rest",
                    "appId": "local.67890abcdef12.34567890",
                    "eventMode": "fetch",
                    "countMessage": 0,
                    "countCommand": 0,
                    "countChat": 0,
                    "countUser": 0
                },
                "users": [
                    {
                        "id": 456,
                        "active": true,
                        "name": "Support Bot",
                        "firstName": "Support",
                        "lastName": "Bot",
                        "workPosition": "AI Assistant",
                        "color": "#df532d",
                        "avatar": "",
                        "gender": "M",
                        "birthday": "",
                        "extranet": false,
                        "bot": true,
                        "connector": false,
                        "externalAuthId": "bot",
                        "status": "online",
                        "idle": false,
                        "lastActivityDate": "2025-01-15T10:30:00+01:00",
                        "absent": false,
                        "departments": [1],
                        "phones": false,
                        "type": "bot"
                    }
                ]
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+01:00",
                "date_finish": "2024-10-11T10:00:00+01:00"
            }
        }

Returned Data

Name `Type`	Description
result `object`	Result of bot registration
result.bot `Bot`	Bot object in extended format (available only to the owner) (detailed description)
result.users `User[]`	Array of associated users (detailed description)
time `time`	Information about the request execution time

Fields of the Bot Object

Field `Type`	Description
id `integer`	Identifier of the bot
code `string`	Symbolic code of the bot
type `string`	Type of the bot
isHidden `boolean`	Bot is hidden from the contact list
isSupportOpenline `boolean`	Bot supports open lines
isReactionsEnabled `boolean`	Reactions are enabled for bot messages
backgroundId [`string	null`](../../../../data-types.md)	ID of the chat background or `null`
language `string`	Language of the bot
moduleId `string`	Module identifier
appId `string`	ID of the application that registered the bot
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`	Identifier of the user
active `boolean`	User is active
name `string`	User's full name
firstName `string`	User's first name
lastName `string`	User's last name
workPosition `string`	Position
color `string`	User's color
avatar `string`	Avatar URL
gender `string`	User's gender
birthday `string`	Date of birth
extranet `boolean`	User is an extranet user
bot `boolean`	Indicates if the user is a bot
connector `boolean`	User is connected via a connector
externalAuthId `string`	External type of authorization
status `string`	User's status
idle `boolean`	User is inactive
lastActivityDate `string`	Date of last activity
absent `boolean`	User is absent
departments `array`	List of departments
phones `array`	List of phones
type `string`	Type of user

Complete descriptions of all object fields can be found on the Objects and Fields page.

Error Handling

HTTP Status: 400, 403

{
            "error": "BOT_CODE_REQUIRED",
            "error_description": "Bot code is required"
        }

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	`fields.botToken` is not specified. Required for authorization via webhook
`BOT_CODE_REQUIRED`	Bot code is required	Bot code (`fields.code`) is not specified
`BOT_PROPERTIES_REQUIRED`	Bot properties are required	Bot properties (name) are not specified
`BOT_CODE_ALREADY_TAKEN`	Bot code is already taken	Bot code is already taken by another application
`BOT_INVALID_TYPE`	Invalid bot type	Invalid bot type. Allowed values: `bot`, `network`, `openline`, `supervisor`, `personal`
`BOT_INVALID_EVENT_MODE`	Invalid event mode	Invalid event delivery mode. Allowed values: `fetch`, `webhook`
`BOT_WEBHOOK_URL_REQUIRED`	Webhook URL is required	`fields.webhookUrl` is not specified when `fields.eventMode = webhook`
`BOT_REGISTER_FAILED`	Bot registration failed	Bot registration error
`BOT_INVALID_CALLBACK`	Invalid callback URL	Invalid handler URL
`BOT_LIMIT_EXCEEDED`	Bot limit exceeded	Application bot limit exceeded (100 bots)
`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)

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

Overview of Methods

Update a Bot

Register a bot imbot.v2.Bot.register

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter propertiesParameter properties

Available BackgroundsAvailable Backgrounds

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