Send System Notification im.notify.system.add

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

Who can execute the method: any user

The method im.notify.system.add sends a system notification to a user.

The method is only available when called through an application.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
USER_ID* `integer`	Identifier of the user receiving the notification. You can obtain the user ID using the methods user.get, user.search, or im.user.get
MESSAGE* `string`	The text of the notification. The method trims whitespace from the edges of the string before sending. Supports BB codes — see more in the Message Formatting section.
MESSAGE_OUT `string`	The text of the notification for external channels, such as email.
TAG `string`	A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with `CLIENT_ID` when calling via webhook.
SUB_TAG `string`	An additional notification tag without uniqueness checks. Pass with `CLIENT_ID` when calling via webhook.
ATTACH `object` `string`	An attachment for the notification in object format or JSON string. See more in the Attachments section.

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 '{"USER_ID":5,"MESSAGE":"System notification","MESSAGE_OUT":"System notification for email","TAG":"SYSTEM_EVENT_42","SUB_TAG":"SYSTEM_EVENT|42"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.system.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_ID":5,"MESSAGE":"System notification","MESSAGE_OUT":"System notification for email","TAG":"SYSTEM_EVENT_42","SUB_TAG":"SYSTEM_EVENT|42","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.notify.system.add

try {
          const response = await $b24.callMethod('im.notify.system.add', {
            USER_ID: 5,
            MESSAGE: 'System notification',
            MESSAGE_OUT: 'System notification for email',
            TAG: 'SYSTEM_EVENT_42',
            SUB_TAG: 'SYSTEM_EVENT|42',
          });
        
          const { result } = response.getData();
          console.log('Notification ID:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service->core->call(
                'im.notify.system.add',
                [
                    'USER_ID' => 5,
                    'MESSAGE' => 'System notification',
                    'MESSAGE_OUT' => 'System notification for email',
                    'TAG' => 'SYSTEM_EVENT_42',
                    'SUB_TAG' => 'SYSTEM_EVENT|42',
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Notification ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'im.notify.system.add',
            {
                USER_ID: 5,
                MESSAGE: 'System notification',
                MESSAGE_OUT: 'System notification for email',
                TAG: 'SYSTEM_EVENT_42',
                SUB_TAG: 'SYSTEM_EVENT|42',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.notify.system.add',
            [
                'USER_ID' => 5,
                'MESSAGE' => 'System notification',
                'MESSAGE_OUT' => 'System notification for email',
                'TAG' => 'SYSTEM_EVENT_42',
                'SUB_TAG' => 'SYSTEM_EVENT|42',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Notification ID: ' . $result['result'];
        }

Response Handling

HTTP Code: 200

{
            "result": 12345,
            "time": {
                "start": 1760000000.0,
                "finish": 1760000000.1,
                "duration": 0.1,
                "processing": 0.04,
                "date_start": "2026-03-02T09:30:00+01:00",
                "date_finish": "2026-03-02T09:30:00+01:00",
                "operating_reset_at": 1760030000,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `integer` `boolean`	Identifier of the created notification. If the notification was not created, it may return `false`
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "USER_ID_EMPTY",
            "error_description": "User 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
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization.	The method was called with session authorization, which is prohibited
`USER_ID_EMPTY`	User ID can't be empty	The `USER_ID` parameter is not provided or `USER_ID <= 0`
`MESSAGE_EMPTY`	Message can't be empty	The message text was not provided
`ATTACH_OVERSIZE`	You have exceeded the maximum allowable size of attach	The maximum allowable size of the `ATTACH` is exceeded — 30 KB
`ATTACH_ERROR`	Incorrect attach params	An incorrect format for the `ATTACH` was provided

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

Send Personal Notification

Retrieve Notifications

Send System Notification im.notify.system.add

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