Update Sent Messages with imconnector.update.messages

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: 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 a `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 like `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)

JS (TS)

JS (UMD)

Python

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": "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

// 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 UpdateMessagesResult = {
          SUCCESS: boolean
          DATA: {
            RESULT: Array<{
              user: string
              message: {
                id: string
                date: object
                text: string
                files?: unknown[]
              }
              chat: {
                id: string
                name: string
                description: string
              }
              extra?: {
                skip_phone_validate?: string
                disable_tracker?: string
              }
              SUCCESS: boolean
              ERRORS?: string[]
            }>
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<UpdateMessagesResult>({
            method: 'imconnector.update.messages',
            params: {
              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: '+499990000000',
                  },
                  message: {
                    id: 'ext-msg-1001',
                    date: 1773266050,
                    text: 'Good afternoon, details clarified',
                  },
                  chat: {
                    id: 'channel-123',
                    name: 'Support channel',
                    url: 'https://example.com/chats/123',
                  },
                },
              ],
            },
            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('Update status:', result.SUCCESS, 'Results:', result.DATA.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 updateMessages() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imconnector.update.messages',
                params: {
                  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: '+499990000000',
                      },
                      message: {
                        id: 'ext-msg-1001',
                        date: 1773266050,
                        text: 'Good afternoon, details clarified',
                      },
                      chat: {
                        id: 'channel-123',
                        name: 'Support channel',
                        url: 'https://example.com/chats/123',
                      },
                    },
                  ],
                },
                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('Update status:', result.SUCCESS, 'Results:', result.DATA.RESULT)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateMessages)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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": "+499990000000",
                        },
                        "message": {
                            "id": "ext-msg-1001",
                            "date": 1773266050,
                            "text": "Good afternoon, details clarified",
                        },
                        "chat": {
                            "id": "channel-123",
                            "name": "Support channel",
                            "url": "https://example.com/chats/123",
                        },
                    },
                ],
            ).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}")

$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',
                        ],
                    ],
                ],
            ]
        );

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imconnector.update.messages", b24.Params{
        	"CONNECTOR": "myconnector",
        	"LINE":      107,
        	"MESSAGES": []b24.Params{
        		{
        			"user": b24.Params{
        				"id":        "ext-user-42",
        				"last_name": "Ivanov",
        				"name":      "Ivan",
        				"picture": b24.Params{
        					"url": "https://example.com/u42.png",
        				},
        				"url":    "https://example.com/users/42",
        				"gender": "male",
        				"email":  "klaus@example.com",
        				"phone":  "+499990000000",
        			},
        			"message": b24.Params{
        				"id":   "ext-msg-1001",
        				"date": 1773266050,
        				"text": "Good afternoon, we clarified the details",
        			},
        			"chat": b24.Params{
        				"id":   "channel-123",
        				"name": "Support Channel",
        				"url":  "https://example.com/chats/123",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("imconnector.update.messages: %w", err)
        }
        
        var item struct {
        	Success bool `json:"SUCCESS"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Success)

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 `type`	Description
SUCCESS `boolean`	Returns `true` if the message was successfully changed
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 user ID 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 message ID
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 the 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	Method called not in the context of an application OAuth
`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`	Failed to find a suitable provider for the connector	Unable to initialize provider for the connector

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Was the article helpful?

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

Was the article helpful?

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