Set a New Chat Name imconnector.chat.name.set
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
The method imconnector.chat.name.set renames the Open Channel chat in Bitrix24 that corresponds to the external system dialog with the specified CHAT_ID. In the external system, the dialog name stays the same.
Bitrix24 looks for an open session by the combination of CONNECTOR, LINE, and CHAT_ID. If there is no such session, the method returns the CHAT_RENAMING_FAILED error.
For connectors with CHAT_GROUP: false, USER_ID also takes part in the search, but it behaves differently: if no interlocutor with this identifier is found, the method returns SUCCESS: true and does not rename the chat.
The method works only in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CONNECTOR* |
The string code of the connector specified in the |
|
LINE* |
Identifier of the Open Channel. The identifier can be obtained using the methods imopenlines.config.get and imopenlines.config.list.get |
|
CHAT_ID* |
Identifier of the chat in the external system — the same value that is passed in |
|
NAME* |
New name for the chat |
|
USER_ID |
Identifier of the interlocutor in the external system — the same value that is passed in The parameter is required for connectors registered with the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CONNECTOR":"connector","LINE":105,"CHAT_ID":"47e007b1-ee15-43db-bcba-1c26e5884d3f","NAME":"New Dialog Name","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imconnector.chat.name.set
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type ChatNameSetResult = {
SUCCESS: boolean
DATA: {
RESULT: Record<string, unknown>
}
}
try {
const response = await $b24.actions.v2.call.make<ChatNameSetResult>({
method: 'imconnector.chat.name.set',
params: {
CONNECTOR: 'connector',
LINE: 105,
CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
NAME: 'New dialog name',
},
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('SUCCESS:', result.SUCCESS, 'DATA:', result.DATA)
}
} 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 setChatName() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.chat.name.set',
params: {
CONNECTOR: 'connector',
LINE: 105,
CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
NAME: 'New dialog name',
},
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('SUCCESS:', result.SUCCESS, 'DATA:', result.DATA)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setChatName)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.chat.name.set(
connector="connector",
line=105,
chat_id="47e007b1-ee15-43db-bcba-1c26e5884d3f",
name="New dialog name",
).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 {
$params = [
'CONNECTOR' => 'connector',
'LINE' => 105,
'CHAT_ID' => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
'NAME' => 'New Dialog Name',
];
$response = $b24Service
->core
->call(
'imconnector.chat.name.set',
$params
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
var params = {
CONNECTOR: 'connector',
LINE: 105,
CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
NAME: 'New Dialog Name'
};
BX24.callMethod(
'imconnector.chat.name.set',
params,
function(result)
{
if(result.error())
alert("Error: " + result.error());
else
alert("Success: " + result.data());
}
);
require_once('crest.php');
$params = [
'CONNECTOR' => 'connector',
'LINE' => 105,
'CHAT_ID' => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
'NAME' => 'New Dialog Name'
];
$result = CRest::call(
'imconnector.chat.name.set',
$params
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imconnector.chat.name.set", b24.Params{
"CONNECTOR": "connector",
"LINE": 105,
"CHAT_ID": "47e007b1-ee15-43db-bcba-1c26e5884d3f",
"NAME": "New Dialog Name",
})
if err != nil {
return fmt.Errorf("imconnector.chat.name.set: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP Status: 200
{
"result": {
"SUCCESS": true,
"DATA": {
"RESULT": {}
}
},
"time": {
"start": 1732110908.525962,
"finish": 1732110908.879113,
"duration": 0.3531508445739746,
"processing": 0.07694888114929199,
"date_start": "2024-11-20T15:55:08+02:00",
"date_finish": "2024-11-20T15:55:08+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of setting the chat name (detailed description) |
|
time |
Information about the request execution time |
result Object
|
Name |
Description |
|
SUCCESS |
Returns The method never returns |
|
DATA |
Service object. The |
Error Handling
HTTP Status: 400, 403
{
"error": "NOT_ACTIVE_LINE",
"error_description": "The line with this ID is inactive or does not exist"
}
|
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 |
|
|
|
Current authorization type is denied for this method Application context required |
The method was called outside the application OAuth context |
|
|
|
Argument 'NAME' is null or empty |
One of the parameters is missing or empty: |
|
|
|
The line with this ID is inactive or does not exist |
The connector is not enabled on this line, or there is no line with this |
|
|
|
Unable to find a suitable provider for the connector |
A connector with this code is not registered in Bitrix24 |
|
|
|
Chat renaming failed |
There is no open session for the combination of parameters passed, or the chat could not be renamed |
Not every rejection comes as an error: if the interlocutor in the external system could not be identified by USER_ID, the method returns SUCCESS: true, but the chat is not renamed.
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 |
Continue Learning
- Register the Connector imconnector.register
- Activate Connector imconnector.activate
- Get the Status of the Connector imconnector.status
- Set Connector Settings imconnector.connector.data.set
- Get the List of Connectors imconnector.list
- Unregister the Connector imconnector.unregister
- Send Messages to Bitrix24 imconnector.send.messages
- Update Sent Messages with imconnector.update.messages
- Delete Sent Messages imconnector.delete.messages
- Update Status "Delivered" imconnector.send.status.delivery
- How to Create an Open Channels Connector for Website Chat