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

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

PATCH /v1/notifications/groups/:groupId

Меняет название группы, созданной пользователем. Условия группы при этом не меняются — они правятся операциями Добавить условие в группу уведомлений и Убрать условие из группы уведомлений.

Параметры

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

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

Поле Тип Обяз. Описание
title string да Новое название группы, от 1 до 255 символов

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/notifications/groups/12" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Рабочие уведомления" }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/notifications/groups/12" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Рабочие уведомления" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups/12', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Рабочие уведомления' }),
})

const { success } = await res.json()
console.log('Группа переименована:', success)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/groups/12', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Рабочие уведомления' }),
})

const { success } = await res.json()
console.log('Группа переименована:', success)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean Всегда true. Признак успеха — HTTP-код 200, а не значение

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

HTTP 200:

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

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

404 — группы нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Группа уведомлений не найдена",
    "b24Code": "GROUP_NOT_FOUND"
  }
}

Ошибки

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

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

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