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

#Создать секцию

POST /v1/calendar-sections

Создаёт новую секцию (календарь) для сотрудника, группы или компании. Битрикс24 создаёт секцию от имени сотрудника, чьи токены привязаны к API-ключу. Администратор портала может создавать секции для других сотрудников.

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

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

Поля только на чтение (id, access, perm, isCollab, createdBy, dateCreate, updatedAt) в теле запроса передавать нельзя — API Вайбкода вернёт 400 READONLY_FIELD.

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/calendar-sections" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "user",
    "ownerId": 1,
    "name": "Командные встречи",
    "description": "Календарь для регулярных созвонов",
    "color": "#9cbeee",
    "textColor": "#283000",
    "export": {
      "ALLOW": true,
      "SET": "3_9"
    }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/calendar-sections" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "user",
    "ownerId": 1,
    "name": "Командные встречи",
    "description": "Календарь для регулярных созвонов",
    "color": "#9cbeee",
    "textColor": "#283000",
    "export": {
      "ALLOW": true,
      "SET": "3_9"
    }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-sections', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'user',
    ownerId: 1,
    name: 'Командные встречи',
    description: 'Календарь для регулярных созвонов',
    color: '#9cbeee',
    textColor: '#283000',
    export: {
      ALLOW: true,
      SET: '3_9',
    },
  }),
})

const { success, data } = await res.json()
console.log('Идентификатор секции:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-sections', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'user',
    ownerId: 1,
    name: 'Командные встречи',
    description: 'Календарь для регулярных созвонов',
    color: '#9cbeee',
    textColor: '#283000',
    export: {
      ALLOW: true,
      SET: '3_9',
    },
  }),
})

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

#Поля ответа

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

Чтобы получить остальные поля созданной секции (color, access, perm и т. д.), запросите `GET /v1/calendar-sections?type=<...>&ownerId=<...>` и найдите запись по id.

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

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

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

400 — передано поле только на чтение:

JSON 
{
  "success": false,
  "error": {
    "code": "READONLY_FIELD",
    "message": "Field 'access' is read-only and cannot be set"
  }
}

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

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "The required parameter \"name\" for the method \"calendar.section.add\" is not set."
  }
}

#Ошибки

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

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

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

Битрикс24 возвращает после создания только id. Это формат метода calendar.section.add — он отдаёт идентификатор новой секции и не включает остальные поля. Чтобы получить созданную секцию полностью (с присвоенными правами access и perm) — сделайте отдельный запрос к `GET /v1/calendar-sections`.

Поле export сохраняет регистр. Передавайте именно { "ALLOW": true, "SET": "3_9" } — ключи в верхнем регистре. API Вайбкода не преобразует ключи внутри export к camelCase. Если ключи передать в нижнем регистре, Битрикс24 их проигнорирует.

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