Create a chat on behalf of the chat bot imbot.chat.add

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: a user of the application that registered the chat bot

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Chat.add.

The method imbot.chat.add creates a chat on behalf of the chat bot.

Method Parameters

Required parameters are marked with *

Name `type`	Description
TYPE `string`	Type of chat. Possible values: `OPEN` — open chat `CHAT` — closed chat Default is `CHAT`
TITLE `string`	Title of the chat
DESCRIPTION `string`	Description of the chat
COLOR `string`	Color of the chat for the mobile application. Possible values: `RED` — red `GREEN` — green `MINT` — mint `LIGHT_BLUE` — light blue `DARK_BLUE` — dark blue `PURPLE` — purple `AQUA` — aqua `PINK` — pink `LIME` — lime `BROWN` — brown `AZURE` — azure `KHAKI` — khaki `SAND` — sand `MARENGO` — marengo `GRAY` — gray `GRAPHITE` — graphite
MESSAGE `string`	Welcome message in the chat
USERS `array`	Array of chat participants
AVATAR `string`	Avatar of the chat in Base64 format. Maximum image size is 5000x5000
ENTITY_TYPE `string`	Type of the object to bind the chat to an external context
ENTITY_ID `string`	Identifier of the object within `ENTITY_TYPE`. When creating a chat, you can pass any pair of `ENTITY_TYPE` and `ENTITY_ID`. The parameters are used to obtain the chat identifier using the method imbot.chat.get and to determine the context in event handlers ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE
BOT_ID `integer`	Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list. If the parameter is not provided, the method searches for the first bot registered by the current application
CLIENT_ID `string`	This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot

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 '{"TYPE":"CHAT","TITLE":"New Chat","DESCRIPTION":"Important News","COLOR":"GREEN","MESSAGE":"Welcome!","USERS":[1271],"AVATAR":"/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==","ENTITY_TYPE":"CHAT","ENTITY_ID":"13","BOT_ID":1291,"CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.add

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"TYPE":"CHAT","TITLE":"New Chat","DESCRIPTION":"Important News","COLOR":"GREEN","MESSAGE":"Welcome!","USERS":[1271],"AVATAR":"/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==","ENTITY_TYPE":"CHAT","ENTITY_ID":"13","BOT_ID":1291,"auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.chat.add

try
        {
            const response = await $b24.callMethod(
                'imbot.chat.add',
                {
                    TYPE: 'CHAT',
                    TITLE: 'New Chat',
                    DESCRIPTION: 'Important News',
                    COLOR: 'GREEN',
                    MESSAGE: 'Welcome!',
                    USERS: [1271],
                    AVATAR: '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                    ENTITY_TYPE: 'CHAT',
                    ENTITY_ID: '13',
                    BOT_ID: 1291
                }
            );
            
            const result = response.getData().result;
            console.log('Created chat with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.chat.add',
                    [
                        'TYPE' => 'CHAT',
                        'TITLE' => 'New Chat',
                        'DESCRIPTION' => 'Important News',
                        'COLOR' => 'GREEN',
                        'MESSAGE' => 'Welcome!',
                        'USERS' => [1271],
                        'AVATAR' => '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                        'ENTITY_TYPE' => 'CHAT',
                        'ENTITY_ID' => '13',
                        'BOT_ID' => 1291
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding chat: ' . $e->getMessage();
        }

BX24.callMethod(
            'imbot.chat.add',
            {
                TYPE: 'CHAT',
                TITLE: 'New Chat',
                DESCRIPTION: 'Important News',
                COLOR: 'GREEN',
                MESSAGE: 'Welcome!',
                USERS: [1271],
                AVATAR: '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                ENTITY_TYPE: 'CHAT',
                ENTITY_ID: '13',
                BOT_ID: 1291
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.chat.add',
            [
                'TYPE' => 'CHAT',
                'TITLE' => 'New Chat',
                'DESCRIPTION' => 'Important News',
                'COLOR' => 'GREEN',
                'MESSAGE' => 'Welcome!',
                'USERS' => [1271],
                'AVATAR' => '/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==',
                'ENTITY_TYPE' => 'CHAT',
                'ENTITY_ID' => '13',
                'BOT_ID' => 1291
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.chat.add", b24.Params{
        	"TYPE":        "CHAT",
        	"TITLE":       "New Chat",
        	"DESCRIPTION": "Important News",
        	"COLOR":       "GREEN",
        	"MESSAGE":     "Welcome!",
        	"USERS":       []int{1271},
        	"AVATAR":      "/9j/4AAQSkZJRgABAQEBLAEsAAD/4QBwRXhp...+gKlSv+1v/2Q==",
        	"ENTITY_TYPE": "CHAT",
        	"ENTITY_ID":   "13",
        	"BOT_ID":      1291,
        	"CLIENT_ID":   "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.chat.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Response Handling

HTTP Status: 200

{
          "result": 2725,
          "time": {
              "start": 1771928379,
              "finish": 1771928380.102187,
              "duration": 1.102186918258667,
              "processing": 1,
              "date_start": "2026-02-24T13:19:39+01:00",
              "date_finish": "2026-02-24T13:19:40+01:00",
              "operating_reset_at": 1771928979,
              "operating": 0.3226499557495117
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created chat
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "WRONG_REQUEST",
            "error_description": "Chat can't be created"
        }

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
`INVALID_FORMAT`	Parameter USERS has wrong type	The `USERS` parameter is in the wrong format
`BOT_ID_ERROR`	Bot not found	Chat bot not found
`APP_ID_ERROR`	Bot was installed by another REST application	The specified chat bot was installed by another application
`WRONG_REQUEST`	Chat can't be created	Failed to create chat

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?

Chat Fields

Add Chat Participants

Create a chat on behalf of the chat bot imbot.chat.add

Method ParametersMethod Parameters

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