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

Добавить условие в группу уведомлений

POST /v1/notifications/groups/:groupId/conditions

Добавляет в группу, созданную пользователем, ещё одну пару модуля и события. После этого группа отбирает и уведомления этого события.

Параметры

Параметр Тип Обяз. Описание
groupId (path) number да Идентификатор группы — значение tag группы с isEditable: true из списка групп, переданное числом. У системных групп confirm, mention и admin числового идентификатора нет

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

Поле Тип Обяз. Описание
module string да Идентификатор модуля, от 1 до 255 символов. Список модулей — поле data[].id в настройках уведомлений, модуль конкретного уведомления — поле notifyModule в ленте уведомлений
event string да Идентификатор события этого модуля, от 1 до 255 символов. События модуля — поле data[].notices[].id в настройках уведомлений, событие конкретного уведомления — поле notifyEvent в ленте уведомлений

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/groups/12/conditions" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "module": "calendar", "event": "invite" }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/groups/12/conditions" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "module": "calendar", "event": "invite" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups/12/conditions', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ module: 'calendar', event: 'invite' }),
})

const { data } = await res.json()
console.log('ID условия:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups/12/conditions', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ module: 'calendar', event: 'invite' }),
})

const { data } = await res.json()
console.log('ID условия:', data.id)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор условия. Для удаления условия он не нужен — условие называется парой module и event

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

HTTP 200:

JSON 
{
  "success": true,
  "data": {
    "id": 31
  }
}

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

422 — такое условие в группе уже есть:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Mysql query error: (1062) Duplicate entry '12-calendar-invite' for key 'b_im_notify_group_condition.UX_IM_NOTIFY_GROUP_CONDITION_GROUP_ID_MODULE_EVENT'",
    "b24Code": "400"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS groupId не положительное целое число, в том числе метка системной группы вроде mention
400 INVALID_PARAMS module или event не передано, не строка, пустая строка или длиннее 255 символов. Имя поля — в message
400 INVALID_PARAMS Передано поле тела не из таблицы выше или параметр запроса, либо тело не JSON-объект
404 ENTITY_NOT_FOUND Группы нет — удалена или принадлежит другому пользователю. Код портала GROUP_NOT_FOUND — в поле error.b24Code. На портале с языком интерфейса, отличным от русского и английского, тот же отказ приходит как 422 BITRIX_ERROR — ориентируйтесь на error.b24Code
422 BITRIX_ERROR Такое условие в группе уже есть. В поле error.b24Code — 400, в message — текст ошибки базы данных Битрикс24 о повторяющейся записи. Отдельного кода у повтора нет — сверяйте состав группы по списку групп до добавления
422 BITRIX_ERROR Битрикс24 отклонил добавление по другой причине, код портала — в поле error.b24Code
403 SCOPE_DENIED У ключа нет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
401 TOKEN_MISSING У ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также