Для AI-агентов: markdown этой страницы — /docs-content/notifications/settings/update.md индекс документации — /llms.txt

Изменить настройку уведомления

PATCH /v1/notifications/settings

Включает или выключает у сотрудника один канал доставки уведомлений — site, mail или push — для одного события модуля портала.

Поля запроса (body)

Поле	Тип	Обяз.	Описание
`module`	string	да	Идентификатор модуля, от 1 до 255 символов. Список: `data[].id` в ответе `GET /v1/notifications/settings`
`event`	string	да	Идентификатор события этого модуля, от 1 до 255 символов. Список: `data[].notices[].id` в том же ответе
`channel`	string	да	Канал доставки: `site`, `mail` или `push`
`enabled`	boolean	да	`true` — включить канал, `false` — выключить
`userId`	number	нет	ID сотрудника, чью настройку изменить, — положительное целое число. Список: `GET /v1/users`. Без поля — сотрудник, от имени которого сделан вызов. Настройки другого сотрудника меняет только администратор Битрикс24

Примеры

curl — личный ключ

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/notifications/settings" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "module": "bizproc", "event": "activity", "channel": "site", "enabled": false }'

curl — OAuth-приложение

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/notifications/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "module": "bizproc", "event": "activity", "channel": "site", "enabled": false }'

JavaScript — личный ключ

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/settings', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ module: 'bizproc', event: 'activity', channel: 'site', enabled: false }),
})
const { data } = await res.json()

JavaScript — OAuth-приложение

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/settings', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ module: 'bizproc', event: 'activity', channel: 'site', enabled: false }),
})
const { data } = await res.json()

Поля ответа

Поле	Тип	Описание
`success`	boolean	`true` при успешном выполнении
`data`	boolean	Всегда `true`, в том числе когда настройка не изменилась

Пример ответа

HTTP 200:

JSON

{
  "success": true,
  "data": true
}

Пример ответа при ошибке

400 — канал не из списка: