Create Chat im.chat.add

Scope: im

Who can execute the method: any user

The method im.chat.add creates a new chat.

Method Parameters

Name
type

Description

USERS
array

An array of user IDs to be added to the chat.

The chat Creator is automatically added to the chat as the Owner

TYPE
string

Type of chat:

  • OPEN — open chat
  • CHAT — closed chat

By default, a closed chat CHAT is created

TITLE
string

Title of the chat.

If the parameter is not provided, the title will be automatically generated using the template #COLOR# chat №#NUMBER# or Chat with #USERS_NAMES#

DESCRIPTION
string

Description of the chat

COLOR
string

Color of the chat. 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

The first message in the chat

AVATAR
string

Avatar of the chat in base64 string format.

Maximum image size is 5000x5000.

Typical use-cases and scenarios

ENTITY_TYPE
string

Type of object to link the chat with external context.

Possible values:

  • VIDEOCONF — video conference chat
  • AI_ASSISTANT_PRIVATE — private chat with AI assistant
  • LINES — open line chat from the operator's side
  • LIVECHAT — open line chat from the client's side
  • ANNOUNCEMENT — announcement chat
  • CALENDAR — chat related to a calendar event
  • MAIL — chat related to email correspondence
  • CRM — chat related to a CRM entity
  • SONET_GROUP — social network group chat
  • TASKS — chat related to a task
  • CALL — chat related to a call

ENTITY_ID
string

Identifier of the object within ENTITY_TYPE.

Passed as a string. The format depends on the selected ENTITY_TYPE.

Supported formats for common types:

  • CRM — <CRM_TYPE>|<ID>, for example LEAD|13, DEAL|1663, CONTACT|25, COMPANY|7. For smart processes — DYNAMIC_<entityTypeId>|<itemId>
  • LINES — <connectorId>|<lineId>|<connectorChatId>|<connectorUserId>, for example telegrambot|2|209607941|744
  • LIVECHAT — <connectorId>|<lineId>
  • TASKS — task identifier, for example 8293
  • CALENDAR — calendar event identifier
  • SONET_GROUP — group identifier

For other ENTITY_TYPE, the format is defined by the module or integration. It can be an arbitrary string.

When creating a chat, you can pass any pair of ENTITY_TYPE and ENTITY_ID. The method get chat identifier will return the chat if called with the same pair of values

COPILOT_MAIN_ROLE
string

Code of the main role for BitrixGPT.

Possible values:

  • copilot_assistant — universal default role
  • any code of an available BitrixGPT role from the AI library

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Deal Chat","DESCRIPTION":"Discussing the deal here","COLOR":"PINK","MESSAGE":"Welcome to the deal chat","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Deal Chat","DESCRIPTION":"Discussing the deal here","COLOR":"PINK","MESSAGE":"Welcome to the deal chat","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.chat.add
        
try
        {
            const response = await $b24.callMethod(
                'im.chat.add',
                {
                    USERS: [103, 547],
                    TYPE: 'CHAT',
                    TITLE: 'Deal Chat',
                    DESCRIPTION: 'Discussing the deal here',
                    COLOR: 'PINK',
                    MESSAGE: 'Welcome to the deal chat',
                    ENTITY_TYPE: 'CRM',
                    ENTITY_ID: 'DEAL|1663'
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.chat.add',
                    [
                        'USERS' => [103, 547],
                        'TYPE' => 'CHAT',
                        'TITLE' => 'Deal Chat',
                        'DESCRIPTION' => 'Discussing the deal here',
                        'COLOR' => 'PINK',
                        'MESSAGE' => 'Welcome to the deal chat',
                        'ENTITY_TYPE' => 'CRM',
                        'ENTITY_ID' => 'DEAL|1663',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'CHAT_ID: ' . $result;
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.chat.add',
            {
                USERS: [103, 547],
                TYPE: 'CHAT',
                TITLE: 'Deal Chat',
                DESCRIPTION: 'Discussing the deal here',
                COLOR: 'PINK',
                MESSAGE: 'Welcome to the deal chat',
                ENTITY_TYPE: 'CRM',
                ENTITY_ID: 'DEAL|1663',
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.chat.add',
            [
                'USERS' => [103, 547],
                'TYPE' => 'CHAT',
                'TITLE' => 'Deal Chat',
                'DESCRIPTION' => 'Discussing the deal here',
                'COLOR' => 'PINK',
                'MESSAGE' => 'Welcome to the deal chat',
                'ENTITY_TYPE' => 'CRM',
                'ENTITY_ID' => 'DEAL|1663',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": 1417,
            "time": {
                "start": 1772009915,
                "finish": 1772009915.872788,
                "duration": 0.8727879524230957,
                "processing": 0,
                "date_start": "2026-02-25T11:58:35+01:00",
                "date_finish": "2026-02-25T11:58:35+01:00",
                "operating_reset_at": 1772010515,
                "operating": 0.20950984954833984
            }
        }

Returned Data

Name
type

Description

result
integer

Identifier of the created chat

time
time

Information about the request execution time

Error Handling

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

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

Previous
About Chats in Bitrix24
Next
Get Chat ID