Create Chat im.chat.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
imWho can execute the method: any user
The method im.chat.add creates a new chat.
Method Parameters
Required parameters are marked with *
The method has no required parameters: without any parameters it creates a closed chat with an automatically generated title, where the current user is the only participant and the owner.
|
Name |
Description |
|
USERS |
An array of user IDs to be added to the chat. The chat Creator is automatically added to the chat as the Owner |
|
TYPE |
Type of chat:
By default, a closed chat |
|
TITLE |
Title of the chat. If the parameter is not provided, the title will be automatically generated using the template |
|
DESCRIPTION |
Description of the chat |
|
COLOR |
Color of the chat. Possible values:
|
|
MESSAGE |
The first message in the chat |
|
AVATAR |
Avatar of the chat in base64 string format. Maximum image size is 5000x5000. Typical use-cases and scenarios |
|
ENTITY_TYPE |
Type of object to link the chat with external context. Possible values:
|
|
ENTITY_ID |
Identifier of the object within Passed as a string. The format depends on the selected Supported formats for common types:
For other |
|
COPILOT_MAIN_ROLE |
Code of the main role for BitrixGPT. Possible values:
|
Specifics of Group and Project Chats
The system chat of a group or project uses this pair of parameters:
{
"ENTITY_TYPE": "SONET_GROUP",
"ENTITY_ID": "133"
}
The ENTITY_TYPE parameter receives the SONET_GROUP string value. The ENTITY_ID parameter receives the group or project identifier.
Do not pass this pair to im.chat.add with the identifier of an existing group or project to create an additional chat within the group. This call can create a second system chat with the same binding.
A duplicate system chat can disrupt task chats in this group:
tasks.task.addcreates a task withoutchatIdand can return theERROR_UNKNOWN_ADD_TASK_ERROR: There was an error while saving task chaterrortasks.task.updateandtasks.task.deletefor this task can return the0: There was an error while creating new task chaterror
Chats with the SONET_GROUP binding are used as standard group and project chats. They cannot be renamed, deleted, left, or rebound using standard chat management methods.
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'im.chat.add',
params: {
USERS: [103, 547],
TYPE: 'CHAT',
TITLE: 'Chat about deal',
DESCRIPTION: 'Discuss the deal here',
COLOR: 'PINK',
MESSAGE: 'Welcome to the deal chat',
ENTITY_TYPE: 'CRM',
ENTITY_ID: 'DEAL|1663',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created chat ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function createChat() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.chat.add',
params: {
USERS: [103, 547],
TYPE: 'CHAT',
TITLE: 'Chat about deal',
DESCRIPTION: 'Discuss the deal here',
COLOR: 'PINK',
MESSAGE: 'Welcome to the deal chat',
ENTITY_TYPE: 'CRM',
ENTITY_ID: 'DEAL|1663',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created chat ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', createChat)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.chat.add(
users=[
103,
547,
],
type="CHAT",
title="Deal chat",
description="Here we discuss the deal",
color="PINK",
message="Welcome to the deal chat",
entity_type="CRM",
entity_id="DEAL|1663",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.chat.add", b24.Params{
"USERS": []int{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",
})
if err != nil {
return fmt.Errorf("im.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": 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 |
Description |
|
result |
Identifier of the created chat |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 401
{
"error": "INVALID_CREDENTIALS",
"error_description": "Invalid request credentials"
}
The method has no error codes of its own — only system REST API errors are possible.
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |