Эндпоинт развёрнут на стадии. Примеры верифицируются после деплоя в продакшен.

#Обновить секцию

PATCH /v1/calendar-sections/:id

Обновляет поля существующей секции. Битрикс24 требует type, ownerId и name в каждом вызове calendar.section.update — поэтому эти три поля обязательны в теле запроса, даже если меняется только цвет или описание.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор секции

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

Поле Тип Обяз. Описание
type string да Тип календаря: user, group. Должен соответствовать type существующей секции — иначе Битрикс24 вернёт ошибку доступа
ownerId number да Идентификатор владельца календаря. Должен соответствовать ownerId существующей секции
name string да Название секции. Битрикс24 требует поле даже при изменении других полей — передавайте текущее значение, если переименование не нужно
description string нет Описание
color string нет Цвет секции (#RRGGBB)
textColor string нет Цвет текста (#RRGGBB)
export object нет Параметры экспорта в формате iCal: { "ALLOW": boolean, "SET": "all" | "3_9" | "6_12" }. Ключи внутри объекта — в верхнем регистре

Поля только на чтение (id, access, perm, isCollab, createdBy, dateCreate, updatedAt) в теле запроса передавать нельзя.

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/calendar-sections/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "user",
    "ownerId": 1,
    "name": "Командные встречи",
    "color": "#FF5733",
    "description": "Обновлённое описание"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/calendar-sections/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "user",
    "ownerId": 1,
    "name": "Командные встречи",
    "color": "#FF5733",
    "description": "Обновлённое описание"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-sections/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'user',
    ownerId: 1,
    name: 'Командные встречи',
    color: '#FF5733',
    description: 'Обновлённое описание',
  }),
})

const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-sections/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'user',
    ownerId: 1,
    name: 'Командные встречи',
    color: '#FF5733',
    description: 'Обновлённое описание',
  }),
})

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор обновлённой секции — единственное поле, которое возвращает Битрикс24

Чтобы получить актуальные значения остальных полей — запросите `GET /v1/calendar-sections?type=<...>&ownerId=<...>`.

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

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

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

422 — пропущено обязательное поле name:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Не задан обязательный параметр \"name\" для метода \"calendar.section.update\""
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Пропущено обязательное поле (type, ownerId, name), некорректное значение или секция с указанным id не существует
400 READONLY_FIELD В теле запроса передано поле только на чтение
403 SCOPE_DENIED API-ключ не имеет скоупа calendar
403 WRITE_BLOCKED_READONLY_KEY API-ключ в режиме «только чтение» — запись запрещена
401 TOKEN_MISSING У API-ключа нет настроенных токенов
502 BITRIX_UNAVAILABLE Битрикс24 временно недоступен — повторите запрос позже

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

#Известные особенности

type, ownerId, name обязательны в каждом вызове. Битрикс24 не реализует частичное обновление для секций — метод calendar.section.update требует все три поля, даже если меняется только цвет. Если переименование не нужно — передайте текущее name (можно получить через `GET /v1/calendar-sections`).

Битрикс24 возвращает только id после обновления. Чтобы увидеть обновлённую секцию полностью — сделайте отдельный запрос к `GET /v1/calendar-sections`.

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