Update Sent Messages with imconnector.update.messages
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:
imopenlinesWho can execute the method: any user
The method imconnector.update.messages updates the data of previously sent messages from an external system in an open line.
The method works only in the context of an application.
The method parameters use values from the external system: user ID, chat ID, chat link, and its name in the application that registered the connector.
To update, pass the same message.id and chat.id that were used when sending messages with the imconnector.send.messages method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CONNECTOR* |
String code of the connector specified in the |
|
LINE* |
Identifier of the open line. The identifier can be obtained using the imopenlines.config.get and imopenlines.config.list.get methods |
|
MESSAGES* |
Array of messages to update. Each element of the array is a single message in the object format with three required blocks: The structure of the object is described in detail below |
MESSAGES Parameter
|
Name |
Description |
|
user |
Data of the user from the external system. The structure of the object is described in detail below |
|
message |
Data of the message from the external system. The structure of the object is described in detail below |
|
chat |
Data of the chat from the external system. The structure of the object is described in detail below |
User Object
|
Name |
Description |
|
id* |
User ID in the external system |
|
last_name |
User's last name |
|
name |
User's first name |
|
picture |
User's avatar in the object format with a |
|
url |
Link to the user's profile in the external system |
|
gender |
User's gender. Supported values are |
|
email |
User's email |
|
phone |
User's phone |
|
skip_phone_validate |
Disables phone validation before saving in CRM. Acceptable value is |
Message Object
|
Name |
Description |
|
id |
ID of the message in the external system that needs to be updated |
|
date |
Message time in Unix Timestamp in seconds |
|
text |
New text of the message. Pass either For acceptable formatting, refer to the article Formatting |
|
files |
Array of files. Each file is passed as an array like |
|
disable_crm |
Disables the CRM tracker for the message. Acceptable value is |
|
user_id |
ID of the manager in Bitrix24. If |
Chat Object
|
Name |
Description |
|
id* |
ID of the chat or channel in the external system. It is recommended to pass the same value as in |
|
name |
Name of the chat or channel. It is recommended to use the value from |
|
url |
Link to the chat or channel in the external system. It is recommended to use the value from |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"CONNECTOR": "myconnector",
"LINE": 107,
"MESSAGES": [
{
"user": {
"id": "ext-user-42",
"last_name": "Ivanov",
"name": "Ivan",
"picture": {"url": "https://example.com/u42.png"},
"url": "https://example.com/users/42",
"gender": "male",
"email": "ivan@example.com",
"phone": "+19990000000"
},
"message": {
"id": "ext-msg-1001",
"date": 1773266050,
"text": "Good afternoon, we clarified the details"
},
"chat": {
"id": "channel-123",
"name": "Support Channel",
"url": "https://example.com/chats/123"
}
}
],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imconnector.update.messages
const payload = {
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
user: {
id: 'ext-user-42',
last_name: 'Ivanov',
name: 'Ivan',
picture: { url: 'https://example.com/u42.png' },
url: 'https://example.com/users/42',
gender: 'male',
email: 'ivan@example.com',
phone: '+19990000000',
},
message: {
id: 'ext-msg-1001',
date: 1773266050,
text: 'Good afternoon, we clarified the details',
},
chat: {
id: 'channel-123',
name: 'Support Channel',
url: 'https://example.com/chats/123',
},
},
],
};
const response = await $b24.callMethod('imconnector.update.messages', payload);
console.log(response.getData());
$result = $b24Service->core->call(
'imconnector.update.messages',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'user' => [
'id' => 'ext-user-42',
'last_name' => 'Ivanov',
'name' => 'Ivan',
'picture' => ['url' => 'https://example.com/u42.png'],
'url' => 'https://example.com/users/42',
'gender' => 'male',
'email' => 'ivan@example.com',
'phone' => '+19990000000',
],
'message' => [
'id' => 'ext-msg-1001',
'date' => 1773266050,
'text' => 'Good afternoon, we clarified the details',
],
'chat' => [
'id' => 'channel-123',
'name' => 'Support Channel',
'url' => 'https://example.com/chats/123',
],
],
],
]
);
BX24.callMethod(
'imconnector.update.messages',
{
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
user: {
id: 'ext-user-42',
last_name: 'Ivanov',
name: 'Ivan',
picture: { url: 'https://example.com/u42.png' },
url: 'https://example.com/users/42',
gender: 'male',
email: 'ivan@example.com',
phone: '+19990000000',
},
message: {
id: 'ext-msg-1001',
date: 1773266050,
text: 'Good afternoon, we clarified the details',
},
chat: {
id: 'channel-123',
name: 'Support Channel',
url: 'https://example.com/chats/123',
},
},
],
},
function(result) {
console.log(result.data());
}
);
$result = CRest::call(
'imconnector.update.messages',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'user' => [
'id' => 'ext-user-42',
'last_name' => 'Ivanov',
'name' => 'Ivan',
'picture' => ['url' => 'https://example.com/u42.png'],
'url' => 'https://example.com/users/42',
'gender' => 'male',
'email' => 'ivan@example.com',
'phone' => '+19990000000',
],
'message' => [
'id' => 'ext-msg-1001',
'date' => 1773266050,
'text' => 'Good afternoon, we clarified the details',
],
'chat' => [
'id' => 'channel-123',
'name' => 'Support Channel',
'url' => 'https://example.com/chats/123',
],
],
],
]
);
Response Handling
HTTP Status: 200
{
"result": {
"SUCCESS": true,
"DATA": {
"RESULT": [
{
"user": "585",
"message": {
"id": "ext-msg-1001",
"date": {},
"text": "Good afternoon, we clarified the details"
},
"chat": {
"id": "channel-123",
"name": "Support Channel",
"description": "Link to the original post: https://example.com/chats/123"
},
"SUCCESS": true
}
]
}
},
"time": {
"start": 1773322669,
"finish": 1773322669.300999,
"duration": 0.3009989261627197,
"processing": 0,
"date_start": "2026-03-12T16:37:49+02:00",
"date_finish": "2026-03-12T16:37:49+02:00",
"operating_reset_at": 1773323269,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
SUCCESS |
Returns |
|
DATA |
Data of the message processing. The structure of the object is described in detail below |
|
time |
Information about the request execution time |
DATA Object
|
Name |
Description |
|
RESULT |
Array of results for each element of The structure of the element is described in detail below |
RESULT[] Object
|
Name |
Description |
|
user |
Internal user ID in Bitrix24 |
|
message |
Data of the message after processing (detailed description) |
|
chat |
Data of the chat after processing (detailed description) |
|
extra |
Additional flags for message processing (detailed description) |
|
SUCCESS |
Indicates successful processing of the current array element |
|
ERRORS |
Array of error texts for the current element, returned when |
Message Object
|
Name |
Description |
|
id |
External message ID |
|
date |
Date of the message after processing |
|
text |
Text of the message |
|
files |
Array of message files |
Chat Object
|
Name |
Description |
|
id |
ID of the chat or channel |
|
name |
Name of the chat or channel |
|
description |
Description of the chat, for example, a link to the original post |
Extra Object
|
Name |
Description |
|
skip_phone_validate |
Indicates phone validation is disabled, returned with value |
|
disable_tracker |
Indicates the CRM tracker is disabled, returned with value |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'LINE' is null or empty"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Current authorization type is denied for this method Application context required |
Method called not in the context of an application OAuth |
|
|
|
Argument 'CONNECTOR' is null or empty |
|
|
|
|
Argument 'LINE' is null or empty |
|
|
|
|
Argument 'MESSAGES' is null or empty |
|
|
|
|
The line with this ID is inactive or does not exist |
An inactive |
|
|
|
Failed to find a suitable provider for the connector |
Unable to initialize provider for the connector |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Delete Sent Messages imconnector.delete.messages
- Update Status "Delivered" imconnector.send.status.delivery
- Set a New Chat Name imconnector.chat.name.set