Эндпоинт развёрнут на стадии. Примеры верифицируются после деплоя в продакшен.
#Удалить секцию
DELETE /v1/calendar-sections/:id
Удаляет секцию (календарь) по идентификатору. Восстановить удалённую секцию через API нельзя — повторите `POST /v1/calendar-sections`, если потребуется снова.
#Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id (path) |
number | да | Идентификатор секции |
type (query или body) |
string | да | Тип календаря: user, group. Битрикс24 не умеет находить секцию по одному id — нужно явно указать пару type + ownerId |
ownerId (query или body) |
number | да | Идентификатор владельца календаря |
Параметры type и ownerId принимаются и в строке запроса, и в теле — если переданы оба, приоритет у строки запроса. Если параметр опущен и там, и там — API Вайбкода возвращает 400 MISSING_REQUIRED_PARAMS до вызова Битрикс24.
#Примеры
#curl — личный ключ (параметры в строке запроса)
curl -X DELETE "https://vibecode.bitrix24.tech/v1/calendar-sections/42?type=user&ownerId=1" \
-H "X-Api-Key: YOUR_API_KEY"
#curl — личный ключ (параметры в теле запроса)
curl -X DELETE "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
}'
#curl — OAuth-приложение
curl -X DELETE "https://vibecode.bitrix24.tech/v1/calendar-sections/42?type=user&ownerId=1" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
#JavaScript — личный ключ
const params = new URLSearchParams({ type: 'user', ownerId: '1' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/calendar-sections/42?${params}`, {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
if (res.status === 204) {
console.log('Секция удалена')
}
#JavaScript — OAuth-приложение
const params = new URLSearchParams({ type: 'user', ownerId: '1' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/calendar-sections/42?${params}`, {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
if (res.status === 204) {
console.log('Удалено')
}
#Ответ
При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, не содержимое.
#Пример ответа
HTTP/1.1 204 No Content
#Пример ответа при ошибке
400 — пропущены type и ownerId:
{
"success": false,
"error": {
"code": "MISSING_REQUIRED_PARAMS",
"message": "DELETE /v1/calendar-sections/:id requires type, ownerId (query or body). Example: DELETE /v1/calendar-sections/:id?type=...&ownerId=...",
"missing": ["type", "ownerId"]
}
}
#Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | MISSING_REQUIRED_PARAMS |
Не переданы type и (или) ownerId — ни в строке запроса, ни в теле. Поле missing в ответе перечисляет конкретные пропущенные ключи |
| 422 | BITRIX_ERROR |
Секция с указанным id не существует или уже удалена |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа calendar |
| 403 | WRITE_BLOCKED_READONLY_KEY |
API-ключ в режиме «только чтение» — запись запрещена |
| 401 | TOKEN_MISSING |
У API-ключа нет настроенных токенов |
| 502 | BITRIX_UNAVAILABLE |
Битрикс24 временно недоступен — повторите запрос позже |
Полный список общих ошибок API — Ошибки.
#Известные особенности
Подтверждения нет. Запрос выполняется без интерактивного подтверждения и без отмены — операция необратима. Перед удалением убедитесь, что секция вам больше не нужна (например, перенесите события в другую секцию через `PATCH /v1/calendar-events/:id` с новым sectionId).
Приоритет строки запроса над телом. Если type и ownerId переданы и в ?type=...&ownerId=..., и в JSON-теле — берутся значения из строки запроса. Тело используется только как запасной источник, когда параметров в строке нет.
#Смотрите также
- Список секций
- События календаря — события привязываются к секции через
sectionId - Batch — массовое удаление