Add User to Existing Chat imopenlines.crm.chat.user.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:
imopenlinesWho can execute the method: any user with access to the CRM object
The method imopenlines.crm.chat.user.add adds a user to a chat associated with a CRM object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CRM_ENTITY_TYPE* |
Type of the CRM object. Possible values:
|
|
CRM_ENTITY* |
Identifier of the CRM object. You can obtain the identifier using the universal method get CRM item list |
|
USER_ID* |
Identifier of the user or bot to be added to the chat. You can obtain the user identifier using the user.get and user.search methods |
|
CHAT_ID |
Identifier of the chat. By default, the last chat associated with the CRM object is used. You can obtain the identifiers of chats associated with the CRM object using the imopenlines.crm.chat.get method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.chat.user.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.user.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: 'imopenlines.crm.chat.user.add',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
USER_ID: 503,
CHAT_ID: 1763,
},
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('Chat ID the user was added to:', 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 addUserToChat() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.crm.chat.user.add',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
USER_ID: 503,
CHAT_ID: 1763,
},
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('Chat ID the user was added to:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addUserToChat)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imopenlines.crm.chat.user.add(
crm_entity_type="lead",
crm_entity=1205,
user_id=503,
chat_id=1763,
).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(
'imopenlines.crm.chat.user.add',
[
'CRM_ENTITY_TYPE' => 'lead',
'CRM_ENTITY' => 1205,
'USER_ID' => 503,
'CHAT_ID' => 1763,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'imopenlines.crm.chat.user.add',
{
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
USER_ID: 503,
CHAT_ID: 1763
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.crm.chat.user.add',
[
'CRM_ENTITY_TYPE' => 'lead',
'CRM_ENTITY' => 1205,
'USER_ID' => 503,
'CHAT_ID' => 1763,
]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imopenlines.crm.chat.user.add", b24.Params{
"CRM_ENTITY_TYPE": "lead",
"CRM_ENTITY": 1205,
"USER_ID": 503,
"CHAT_ID": 1763,
})
if err != nil {
return fmt.Errorf("imopenlines.crm.chat.user.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": 1763,
"time": {
"start": 1773814042,
"finish": 1773814043.189039,
"duration": 1.1890389919281006,
"processing": 0,
"date_start": "2026-03-18T09:07:22+01:00",
"date_finish": "2026-03-18T09:07:23+01:00",
"operating_reset_at": 1773814643,
"operating": 0.16756796836853027
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the chat to which the user has been added. If |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error": "CHAT_NOT_IN_CRM",
"error_description": "Chat does not belong to the CRM object being checked"
}
|
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 |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access denied! You don't have access to join user to chat |
The user executing the method does not have permission to add users to the CRM object chat |
|
|
|
Access denied! This user does not have access to the chat because he does not have access to this CRM object |
The user |
|
|
|
Argument 'CRM_ENTITY_TYPE' is null or empty |
Required parameter |
|
|
|
Argument 'CRM_ENTITY' is null or empty |
Required parameter |
|
|
|
The value of an argument 'CRM_ENTITY' has an invalid type |
The |
|
|
|
Argument 'Empty USER_ID' is null or empty |
Required parameter |
|
|
|
Messenger is not installed. |
The |
|
|
|
Chat does not belong to the CRM object being checked |
The chat |
|
|
|
User not active |
User |
|
|
|
Access denied! This user does not have access to the chat because he does not have access to this view chat history |
User |
|
|
|
You don't have access or user already member in chat |
The user is already in the chat or is unavailable for adding |
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 |