Update Message Delivery Status messageservice.message.status.update

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

Who can execute the method: message sender or administrator

The method messageservice.message.status.update updates the delivery status of a message sent through a messaging provider.

This method works only within the context of an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Provider code. The provider code can be obtained using the messageservice.sender.list method.
MESSAGE_ID* `string`	External identifier of the message, received by the application handler when the message was sent.
STATUS* `string`	New status of the message. Supported values: `queued` — message is queued for sending `sent` — message has been sent by the provider `delivered` — message has been successfully delivered to the recipient `undelivered` — message was not delivered to the recipient `failed` — error occurred while sending or processing the message by the provider

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 '{"CODE":"provider1","MESSAGE_ID":"65575980fa531ac284c2ee68f81ebebd","STATUS":"delivered","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/messageservice.message.status.update

try
        {
            const response = await $b24.callMethod(
                'messageservice.message.status.update',
                {
                    CODE: 'provider1',
                    MESSAGE_ID: '65575980fa531ac284c2ee68f81ebebd',
                    STATUS: 'delivered'
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'messageservice.message.status.update',
                    [
                        'CODE' => 'provider1',
                        'MESSAGE_ID' => '65575980fa531ac284c2ee68f81ebebd',
                        'STATUS' => 'delivered',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating message status: ' . $e->getMessage();
        }

BX24.callMethod(
            'messageservice.message.status.update',
            {
                CODE: 'provider1',
                MESSAGE_ID: '65575980fa531ac284c2ee68f81ebebd',
                STATUS: 'delivered'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'messageservice.message.status.update',
            [
                'CODE' => 'provider1',
                'MESSAGE_ID' => '65575980fa531ac284c2ee68f81ebebd',
                'STATUS' => 'delivered',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1742895600,
                "finish": 1742895600.845505,
                "duration": 0.845505952835083,
                "processing": 0,
                "date_start": "2025-03-25T10:00:00+01:00",
                "date_finish": "2025-03-25T10:00:00+01:00",
                "operating_reset_at": 1742896200,
                "operating": 0
            }
        }

Returned Data

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

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_MESSAGE_STATUS_INCORRECT",
            "error_description": "Message status incorrect!"
        }

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
`ERROR_SENDER_VALIDATION_FAILURE`	`Empty sender code!`	Required parameter `CODE` is missing.
`ERROR_SENDER_VALIDATION_FAILURE`	`Wrong sender code!`	`CODE` contains invalid characters.
`ERROR_MESSAGE_NOT_FOUND`	`Message not found!`	Message with the specified `MESSAGE_ID` was not found.
`ERROR_MESSAGE_STATUS_INCORRECT`	`Message status incorrect!`	An unsupported `STATUS` was provided.
`ACCESS_DENIED`	`Application context required`	Method was called outside the application context.
`ACCESS_DENIED`	`Access denied!`	Method was invoked by a non-administrator.

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Delete Provider

Example of Message Provider

Update Message Delivery Status messageservice.message.status.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