Переименовать папку

PATCH /v1/folders/:id

Переименовывает папку. Принимает только поле name. Чтобы переместить папку в другую родительскую, используйте `POST /v1/folders/:id/moveto`.

Параметры

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

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

Поле Битрикс24 Тип Обяз. Описание
name NAME string да Новое имя папки

Поля parentId и code неизменяемы — их передача возвращает 400 READONLY_FIELD. Чтобы переместить папку в другую родительскую, используйте `POST /v1/folders/:id/moveto`.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/folders/9301" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Договоры"}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/folders/9301" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Договоры"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/9301', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Договоры' }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/folders/9301', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Договоры' }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект папки после переименования. Все поля — см. Поля папки

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

JSON 
{
  "success": true,
  "data": {
    "id": 9301,
    "name": "Договоры",
    "code": null,
    "storageId": 1,
    "type": "folder",
    "realObjectId": 9301,
    "parentId": 27,
    "deletedType": 0,
    "createdAt": "2026-06-25T12:10:00.000Z",
    "updatedAt": "2026-06-25T12:15:30.000Z",
    "deletedAt": null,
    "createdBy": 1,
    "updatedBy": 1,
    "deletedBy": 0,
    "detailUrl": "https://<portal>.bitrix24.ru/company/personal/user/1/disk/path/Загруженные файлы/Договоры"
  }
}

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

400 — попытка изменить неизменяемое поле:

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

Ошибки

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

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

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