Update Sent Messages with imconnector.update.messages

Scope: imopenlines

Who 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 `type`	Description
CONNECTOR* `string`	String code of the connector specified in the `ID` parameter when calling imconnector.register
LINE* `integer`	Identifier of the open line. The identifier can be obtained using the imopenlines.config.get and imopenlines.config.list.get methods
MESSAGES* `array`	Array of messages to update. Each element of the array is a single message in the object format with three required blocks: `user`, `message`, `chat`. The structure of the object is described in detail below

MESSAGES Parameter

Name `type`	Description
user `object`	Data of the user from the external system. The structure of the object is described in detail below
message `object`	Data of the message from the external system. The structure of the object is described in detail below
chat `object`	Data of the chat from the external system. The structure of the object is described in detail below

User Object

Name `type`	Description
id* `string`	User ID in the external system
last_name `string`	User's last name
name `string`	User's first name
picture `object`	User's avatar in the object format with the `url` field, for example `{"url":"https://example.com/u42.png"}`
url `string`	Link to the user's profile in the external system
gender `string`	User's gender. Supported values are `male` and `female`
email `string`	User's email
phone `string`	User's phone
skip_phone_validate `string`	Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter

Message Object

Name `type`	Description
id `string`	ID of the message in the external system that needs to be updated
date `integer`	Message time in Unix Timestamp in seconds
text `string`	New text of the message. Pass either `text` or `files` For acceptable formatting, refer to the article Formatting
files `array`	Array of files. Each file is passed as an array of the form `array('url' => 'File link', 'name' => 'File name')`
disable_crm `string`	Disables the CRM tracker for the message. Acceptable value is `Y`
user_id `integer`	ID of the manager in Bitrix24. If `user_id` is passed, the message will be updated on behalf of this manager

Chat Object

Name `type`	Description
id* `string`	ID of the chat or channel in the external system. It is recommended to pass the same value as in `DATA.ID` of the imconnector.connector.data.set method
name `string`	Name of the chat or channel. It is recommended to use the value from `DATA.NAME`
url `string`	Link to the chat or channel in the external system. It is recommended to use the value from `DATA.URL`

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

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": "Johnson",
                  "name": "James",
                  "picture": {"url": "https://example.com/u42.png"},
                  "url": "https://example.com/users/42",
                  "gender": "male",
                  "email": "james@example.com",
                  "phone": "+19990000000"
                },
                "message": {
                  "id": "ext-msg-1001",
                  "date": 1773266050,
                  "text": "Good afternoon, we have 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: 'Johnson',
                        name: 'James',
                        picture: { url: 'https://example.com/u42.png' },
                        url: 'https://example.com/users/42',
                        gender: 'male',
                        email: 'james@example.com',
                        phone: '+19990000000',
                    },
                    message: {
                        id: 'ext-msg-1001',
                        date: 1773266050,
                        text: 'Good afternoon, we have 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' => 'Johnson',
                              'name' => 'James',
                              'picture' => ['url' => 'https://example.com/u42.png'],
                              'url' => 'https://example.com/users/42',
                              'gender' => 'male',
                              'email' => 'james@example.com',
                              'phone' => '+19990000000',
                        ],
                        'message' => [
                              'id' => 'ext-msg-1001',
                              'date' => 1773266050,
                              'text' => 'Good afternoon, we have 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: 'Johnson',
                            name: 'James',
                            picture: { url: 'https://example.com/u42.png' },
                            url: 'https://example.com/users/42',
                            gender: 'male',
                            email: 'james@example.com',
                            phone: '+19990000000',
                        },
                        message: {
                            id: 'ext-msg-1001',
                            date: 1773266050,
                            text: 'Good afternoon, we have 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' => 'Johnson',
                            'name' => 'James',
                            'picture' => ['url' => 'https://example.com/u42.png'],
                            'url' => 'https://example.com/users/42',
                            'gender' => 'male',
                            'email' => 'jamesn@example.com',
                            'phone' => '+19990000000',
                        ],
                        'message' => [
                            'id' => 'ext-msg-1001',
                            'date' => 1773266050,
                            'text' => 'Good afternoon, we have 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 have 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 `type`	Description
SUCCESS `boolean`	Returns `true` if the message was successfully updated
DATA `object`	Data of the message processing. The structure of the object is described in detail below
time `time`	Information about the request execution time

DATA Object

Name
type

Description

RESULT
array

Array of results for each element of MESSAGES.

The structure of the element is described in detail below

RESULT[] Object

Name `type`	Description
user `string`	Internal ID of the user in Bitrix24
message `object`	Data of the message after processing (detailed description)
chat `object`	Data of the chat after processing (detailed description)
extra `object`	Additional flags for message processing (detailed description)
SUCCESS `boolean`	Indicates successful processing of the current array element
ERRORS `array`	Array of error texts for the current element, returned when `SUCCESS = false`

Message Object

Name `type`	Description
id `string`	External ID of the message
date `object`	Date of the message after processing
text `string`	Text of the message
files `array`	Array of message files

Chat Object

Name `type`	Description
id `string`	ID of the chat or channel
name `string`	Name of the chat or channel
description `string`	Description of the chat, for example, a link to the original post

Extra Object

Name `type`	Description
skip_phone_validate `string`	Indicates phone validation is disabled, returned with value `Y`
disable_tracker `string`	Indicates CRM tracker is disabled, returned with value `Y`

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'LINE' is null or empty"
        }

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

Possible Error Codes

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method. Application context required	Method called outside of the application OAuth context
`400`	`ERROR_ARGUMENT`	Argument 'CONNECTOR' is null or empty	`CONNECTOR` not provided
`400`	`ERROR_ARGUMENT`	Argument 'LINE' is null or empty	`LINE` not provided
`400`	`ERROR_ARGUMENT`	Argument 'MESSAGES' is null or empty	`MESSAGES` not provided
`400`	`NOT_ACTIVE_LINE`	The line with this ID is inactive or does not exist	An inactive `LINE` was provided
`400`	`IMCONNECTOR_NO_CORRECT_PROVIDER`	Unable to find a suitable provider for the connector	Failed to initialize the 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 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

Send Messages to Bitrix24

Delete Sent Messages

Update Sent Messages with imconnector.update.messages

Method ParametersMethod Parameters

MESSAGES ParameterMESSAGES Parameter

User ObjectUser Object

Message ObjectMessage Object

Chat ObjectChat Object

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

DATA ObjectDATA Object

RESULT[] ObjectRESULT[] Object

Message ObjectMessage Object

Chat ObjectChat Object

Extra ObjectExtra Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

MESSAGES Parameter

User Object

Message Object

Chat Object

Code Examples

Response Handling

Returned Data

DATA Object

RESULT[] Object

Message Object

Chat Object

Extra Object

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning