Send Personal Notification im.notify.personal.add
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:
imWho can execute the method: any user
The method im.notify.personal.add sends a personal notification on behalf of the current user.
The method cannot be called with session authorization — it returns the WRONG_AUTH_TYPE error. Call it via a webhook or with an application token.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
USER_ID* |
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* |
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 |
The text of the notification for external channels, such as email. If not provided, an empty value is sent |
|
TAG |
A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with |
|
SUB_TAG |
An additional tag for the notification without uniqueness checks. Pass with |
|
Attachment for the notification in object format or JSON string. See more in the Attachments section |
|
|
CLIENT_ID |
The application identifier. The parameter is required only when calling via a webhook: pass it together with |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":5,"MESSAGE":"Task Reminder","MESSAGE_OUT":"Task Reminder (email)","TAG":"TASK_REMINDER_42","SUB_TAG":"TASK_REMINDER|42"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.personal.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":5,"MESSAGE":"Task Reminder","MESSAGE_OUT":"Task Reminder (email)","TAG":"TASK_REMINDER_42","SUB_TAG":"TASK_REMINDER|42","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.notify.personal.add
// 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
try {
const response = await $b24.actions.v2.call.make<number | false>({
method: 'im.notify.personal.add',
params: {
USER_ID: 5,
MESSAGE: 'Task reminder',
MESSAGE_OUT: 'Task reminder (email)',
TAG: 'TASK_REMINDER_42',
SUB_TAG: 'TASK_REMINDER|42',
},
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('Notification ID:', 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 sendPersonalNotification() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.personal.add',
params: {
USER_ID: 5,
MESSAGE: 'Task reminder',
MESSAGE_OUT: 'Task reminder (email)',
TAG: 'TASK_REMINDER_42',
SUB_TAG: 'TASK_REMINDER|42',
},
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('Notification ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendPersonalNotification)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.notify.personal.add(
user_id=5,
message="Task notification",
message_out="Task notification (email)",
tag="TASK_REMINDER_42",
sub_tag="TASK_REMINDER|42",
).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}")
try {
$response = $b24Service->core->call(
'im.notify.personal.add',
[
'USER_ID' => 5,
'MESSAGE' => 'Task Reminder',
'MESSAGE_OUT' => 'Task Reminder (email)',
'TAG' => 'TASK_REMINDER_42',
'SUB_TAG' => 'TASK_REMINDER|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.personal.add',
{
USER_ID: 5,
MESSAGE: 'Task Reminder',
MESSAGE_OUT: 'Task Reminder (email)',
TAG: 'TASK_REMINDER_42',
SUB_TAG: 'TASK_REMINDER|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.personal.add',
[
'USER_ID' => 5,
'MESSAGE' => 'Task Reminder',
'MESSAGE_OUT' => 'Task Reminder (email)',
'TAG' => 'TASK_REMINDER_42',
'SUB_TAG' => 'TASK_REMINDER|42',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Notification ID: ' . $result['result'];
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.notify.personal.add", b24.Params{
"USER_ID": 5,
"MESSAGE": "Task Reminder",
"MESSAGE_OUT": "Task Reminder (email)",
"TAG": "TASK_REMINDER_42",
"SUB_TAG": "TASK_REMINDER|42",
})
if err != nil {
return fmt.Errorf("im.notify.personal.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP Status: 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 |
Description |
|
Identifier of the created notification. If the notification is not created, it may return |
|
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400, 403
{
"error": "USER_ID_EMPTY",
"error_description": "User ID can't be empty"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access for this method not allowed by session authorization |
Method called with session authorization, which is prohibited for it |
|
|
User ID can't be empty |
Parameter |
|
|
Message can't be empty |
Message text not provided |
|
|
You have exceeded the maximum allowable size of attach |
Exceeded the allowable size of attachment |
|
|
Incorrect attach params |
Incorrect format of attachment |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Send Notification im.notify
- Send System Notification im.notify.system.add
- Get Notifications im.notify.get
- Get Notification Type Schema im.notify.schema.get
- Read the list of notifications im.notify.read.list
- Read or Mark Notification as Unread im.notify.read
- Read All Notifications im.notify.read.all
- Responding to Notifications with Quick Response im.notify.answer
- Interacting with Notification Buttons im.notify.confirm
- Delete Notification im.notify.delete
- Searching Notification History im.notify.history.search