Update Message im.message.update

Scope: im

Who can execute the method: message author

The method im.message.update modifies the text and parameters of an already sent message.

Method Parameters

Required parameters are marked with *

Name `type`	Description
MESSAGE_ID* `integer`	Identifier of the message. The identifier is returned by the method im.message.add
MESSAGE `string`	New text of the message. If an empty value is provided, the message will be deleted. If the parameter is not provided, the message text will remain unchanged
ATTACH `object` `string`	Attachment with content blocks: images, links, files. To remove the attachment, pass `N` or an empty value. Read more in the Attachments section
KEYBOARD `object` `string`	Buttons below the message that the user can interact with. To disable the display of buttons, pass `N` or an empty value. Read more in the Working with Keyboards article
MENU `object` `string`	Additional items in the chat's context menu. To disable the display of additional menu items, pass `N` or an empty value. Read more in the Context Menu article
URL_PREVIEW `string`	Conversion of links into rich links. Allowed values: `Y` — enabled `N` — disabled
IS_EDITED `string`	Flag to mark as "edited": `Y` — mark `N` — do not mark Default is `Y` The parameter is applied when updating `ATTACH`. When changing `MESSAGE`, the "edited" label may appear even if `IS_EDITED = 'N'` is passed.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34239,"MESSAGE":"Updated text","KEYBOARD":"N"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34239,"MESSAGE":"Updated text","KEYBOARD":"N","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.message.update

try
        {
            const response = await $b24.callMethod(
                'im.message.update',
                {
                    MESSAGE_ID: 34239,
                    MESSAGE: 'Updated text',
                    KEYBOARD: 'N'
                }
            );
            
            const result = response.getData().result;
            console.log(result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.message.update',
                    [
                        'MESSAGE_ID' => 34239,
                        'MESSAGE' => 'Updated text',
                        'KEYBOARD' => 'N'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating message: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.message.update',
            {
                MESSAGE_ID: 34239,
                MESSAGE: 'Updated text',
                KEYBOARD: 'N'
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.message.update',
            [
                'MESSAGE_ID' => 34239,
                'MESSAGE' => 'Updated text',
                'KEYBOARD' => 'N'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1772623160,
                "finish": 1772623160.616113,
                "duration": 0.6161129474639893,
                "processing": 0,
                "date_start": "2026-03-04T14:19:20+01:00",
                "date_finish": "2026-03-04T14:19:20+01:00",
                "operating_reset_at": 1772623760,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	`true` if the message was updated
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error": "MESSAGE_ID_ERROR",
            "error_description": "Message ID can't be 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

Code	Description	Value
`MESSAGE_ID_ERROR`	Message ID can't be empty	`MESSAGE_ID` is not provided or is invalid
`CANT_EDIT_MESSAGE`	Time has expired for modification or you don't have access	No permission to edit the message or the modification period has expired
`ATTACH_ERROR`	Incorrect attach params	Invalid `ATTACH` object
`ATTACH_OVERSIZE`	You have exceeded the maximum allowable size of attach	The size of `ATTACH` exceeds the allowable limit
`KEYBOARD_ERROR`	Incorrect keyboard params	Invalid `KEYBOARD` object
`KEYBOARD_OVERSIZE`	You have exceeded the maximum allowable size of keyboard	The size of `KEYBOARD` exceeds the allowable limit
`menu_ERROR`	Incorrect menu params	Invalid `MENU` object
`MENU_OVERSIZE`	You have exceeded the maximum allowable size of menu	The size of `MENU` exceeds the allowable limit

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

Add Message

Change "Like" Status of a Message

Update Message im.message.update

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning