Удалить папку

DELETE /v1/folders/:id

Удаляет папку. Удаление мягкое — папка переносится в корзину Битрикс24 вместе со всем содержимым. Восстановить удалённую папку через API нельзя.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID папки. Список: GET /v1/folders

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/folders/9301" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/folders/9301" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/9301', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Папка удалена')
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/9301', {
  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

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

404 — папка не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Could not find entity with id '999999'."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Папки с указанным id нет
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING API-ключ не имеет настроенных токенов портала

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

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

Удаление помечает папку как удалённую и переносит её в корзину, не стирая физически. Сразу после удаления запись ещё доступна через GET /v1/folders/:id с полем deletedType равным 3 — в корзине. Удалённая папка остаётся в Битрикс24 до окончательной очистки.

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