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

Создать группу уведомлений

POST /v1/notifications/groups

Создаёт группу уведомлений сразу с первым условием — парой модуля и события. Следующие условия добавляются в готовую группу операцией Добавить условие в группу уведомлений.

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

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

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/groups" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Задачи и календарь", "module": "tasks", "event": "comment" }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/groups" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Задачи и календарь", "module": "tasks", "event": "comment" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Задачи и календарь', module: 'tasks', event: 'comment' }),
})

const { data } = await res.json()
console.log('ID группы:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Задачи и календарь', module: 'tasks', event: 'comment' }),
})

const { data } = await res.json()
console.log('ID группы:', data.id)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор новой группы. В списке групп он приходит строкой в поле tag

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

HTTP 200:

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

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

400 — не передано название title:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `title` must be a non-empty string of up to 255 characters."
  }
}

Ошибки

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

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

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