> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Отправить уведомление

> Создаёт уведомление для выбранного пользователя через Super key.

Создаёт уведомление для выбранного пользователя через Super key.

## Доступ

Передавайте `XF-Api-Key` в заголовке каждого запроса. [Типы ключей и выбор пользователя](https://docs.arzguard.com/guard-forum/authentication.md).

Требуемые scopes: `alert:write`. Все перечисленные разрешения нужны одновременно.

Метод доступен только с Super key.

## Параметры

**XF-Api-Key** `string` *required*

Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.

Тело запроса: `application/x-www-form-urlencoded`. Вложенные значения передавайте в форме с квадратными скобками в имени поля.

**to\_user\_id** `integer` *required*

ID получателя уведомления.

**alert** `string` *required*

Текст уведомления. Маркер `{link}` заменяется ссылкой из `link_url`.

**from\_user\_id** `integer`

ID отправителя. По умолчанию используется текущий API-пользователь; `0` означает анонимного отправителя.

**link\_url** `string`

Адрес перехода из уведомления.

**link\_title** `string`

Подпись ссылки. Если в тексте нет `{link}`, ссылка добавляется в конец уведомления.

## Ответ

HTTP `200`, JSON. [Схемы объектов и условные поля](https://docs.arzguard.com/guard-forum/models.md).

**success** `true`

Результат выполнения операции.

Ошибки возвращаются в общей структуре `errors`. Обрабатывайте поле `code`; текст `message` может меняться или переводиться. [Формат ошибок](https://docs.arzguard.com/guard-forum/requests-and-errors.md).

```bash cURL theme={null}
curl --request POST 'https://forum.arzguard.com/api/alerts/' \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'to_user_id=42' \
  --data-urlencode 'alert=Пример уведомления'
```

```json 200 · условный пример theme={null}
{
  "success": true
}
```

Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.