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

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

POST /v1/calendar-sections

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

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

Поле Тип Обяз. Описание
Полеtype Типstring Обяз.да ОписаниеТип календаря: user, group
ПолеownerId Типnumber Обяз.да ОписаниеИдентификатор владельца календаря. Для сотрудника — GET /v1/users, для рабочей группы — её id
Полеname Типstring Обяз.да ОписаниеНазвание секции
Полеdescription Типstring Обяз.нет ОписаниеОписание
Полеcolor Типstring Обяз.нет ОписаниеЦвет секции в формате #RRGGBB
ПолеtextColor Типstring Обяз.нет ОписаниеЦвет текста в формате #RRGGBB
Полеexport Типobject Обяз.нет ОписаниеПараметры экспорта в формате iCal. Ключи внутри объекта — в верхнем регистре
Полеexport.ALLOW Типboolean Обяз.нет ОписаниеРазрешить экспорт календаря
Полеexport.SET Типstring Обяз.нет ОписаниеПериод экспорта: 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 ОписаниеИдентификатор созданной секции — единственное поле в ответе на создание

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

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

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Недопустимое значение параметра \"name\""
  }
}

Ошибки

HTTP Код Описание
HTTP422 КодBITRIX_ERROR ОписаниеПропущено обязательное поле type, ownerId или name, либо некорректное значение поля
HTTP400 КодREADONLY_FIELD ОписаниеВ теле запроса передано поле только на чтение — id, access, perm, isCollab, createdBy, dateCreate, updatedAt
HTTP400 КодEMPTY_CREATE_BODY ОписаниеТело запроса пустое — передайте хотя бы одно поле
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа calendar
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеAPI-ключ в режиме «только чтение» — запись запрещена
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа нет настроенных токенов
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеИсход создания неизвестен: Битрикс24 мог принять запрос. Найдите секцию отдельным чтением и повторяйте создание только если убедились, что её нет

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

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

Ответ на создание содержит только id. Остальные поля новой секции, включая присвоенные access и perm, в ответе не приходят — чтобы получить их, сделайте отдельный запрос к GET /v1/calendar-sections.

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

Ключ SET обратно не приходит. Список секций отдаёт export с ключами ALLOW, PATH и LINK — период выгрузки в ответе не появляется. Если период нужен для отображения, сохраните переданное значение у себя.

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