Update Sent Message with imbot.message.update

Scope: imbot

Who can execute the method: an authorized user of the application that registered the chatbot. This method only works with bots from this application.

The method imbot.message.update modifies a previously sent message from the chatbot.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
BOT_ID `integer`	The identifier of the chatbot. It can be obtained using the method imbot.bot.list. If the parameter is not provided, the method searches for the first bot registered by the current application.
MESSAGE_ID* `integer`	The identifier of the message to be modified. The value must be greater than `0`. For messages sent by the bot via REST, the identifier is returned by the method imbot.message.add.
MESSAGE `string`	The 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`	An attachment with content blocks: images, links, files. You can provide: a JSON string an object with the root key `BLOCKS` an array of blocks without wrapping For more details, refer to the section Attachments. An empty value or `N` clears the attachment.
KEYBOARD `object` `string`	Buttons below the message that the user can interact with. For more details, refer to the article Working with Keyboards. An empty value or `N` disables the display of buttons.
MENU `object` `string`	Additional items in the chat's context menu. For more details, refer to the article Context Menu. An empty value or `N` disables the display of additional items.
URL_PREVIEW `string`	Controls the display of links: when enabled, the link is shown as a "rich link" with a card. Allowed values: `Y` — enabled, default value `N` — disabled
SKIP_CONNECTOR `string`	Skips sending the message to external connectors of Open Channels when updating `MESSAGE`. Allowed values: `Y` — skip `N` — do not skip, default value
CLIENT_ID `string`	This parameter is required only for webhooks. Provide the same CLIENT_ID that was specified when registering the chatbot.

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 '{"BOT_ID":39,"MESSAGE_ID":19880117,"MESSAGE":"Updated text","URL_PREVIEW":"Y","CLIENT_ID":"**put_your_client_id_here**"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.update

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"BOT_ID":39,"MESSAGE_ID":19880117,"MESSAGE":"Updated text","URL_PREVIEW":"Y","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.message.update

try {
          const response = await $b24.callMethod('imbot.message.update', {
            BOT_ID: 39,
            MESSAGE_ID: 19880117,
            MESSAGE: 'Updated text',
            URL_PREVIEW: 'Y',
          });
        
          const { result } = response.getData();
          console.log('Updated:', result);
        } catch (error) {
          console.error('Error updating message:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.message.update',
                    [
                        'BOT_ID' => 39,
                        'MESSAGE_ID' => 19880117,
                        'MESSAGE' => 'Updated text',
                        'URL_PREVIEW' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Updated: ' . ($result->data() ? 'true' : 'false');
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error updating message: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.message.update',
            {
                BOT_ID: 39,
                MESSAGE_ID: 19880117,
                MESSAGE: 'Updated text',
                URL_PREVIEW: 'Y',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.message.update',
            [
                'BOT_ID' => 39,
                'MESSAGE_ID' => 19880117,
                'MESSAGE' => 'Updated text',
                'URL_PREVIEW' => 'Y',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Updated: ' . ($result['result'] ? 'true' : 'false');
        }

Response Handling

HTTP Code: 200

{
            "result": true,
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `boolean`	`true` if the request was processed without error.
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
`BOT_ID_ERROR`	Bot not found	The bot is not found or the application does not have an available bot for auto-filling `BOT_ID`.
`APP_ID_ERROR`	Bot was installed by another REST application	The provided `BOT_ID` belongs to another application.
`MESSAGE_ID_ERROR`	Message ID can't be empty	A valid `MESSAGE_ID` was not provided.
`ATTACH_ERROR`	Incorrect attach params	Invalid structure of `ATTACH`.
`ATTACH_OVERSIZE`	You have exceeded the maximum allowable size of attach	The allowable size of `ATTACH` has been exceeded — 30 KB.
`KEYBOARD_ERROR`	Incorrect keyboard params	Invalid structure of `KEYBOARD`.
`KEYBOARD_OVERSIZE`	You have exceeded the maximum allowable size of keyboard	The allowable size of `KEYBOARD` has been exceeded — 30 KB.
`MENU_ERROR`	Incorrect menu params	Invalid structure of `MENU`.
`MENU_OVERSIZE`	You have exceeded the maximum allowable size of menu	The allowable size of `MENU` has been exceeded — 30 KB.
`CANT_EDIT_MESSAGE`	Time has expired for modification or you don't have access	No access to modify the message or the editing time has expired — more than three days have passed since publication.

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 Message

Delete Message

Update Sent Message with imbot.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