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

Переименовать файл

PATCH /v1/files/:id

Переименовывает файл на диске. Расположение файла и остальные его поля не меняются.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID файла. Список: GET /v1/files с обязательным folderId

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

Поле Тип Обяз. Описание
Полеname Типstring Обяз.да ОписаниеНовое имя файла с расширением. Имя должно быть свободно в папке назначения

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/files/9251" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-renamed.txt"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/files/9251" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-renamed.txt"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/files/9251', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-renamed.txt',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/files/9251', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-renamed.txt',
  }),
})

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

Поля ответа

Набор полей совпадает с ответом GET /v1/files/:id.

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типnumber ОписаниеИдентификатор файла
Полеdata.name Типstring ОписаниеНовое имя файла
Полеdata.code Типstring|null ОписаниеСимвольный код файла
Полеdata.storageId Типnumber ОписаниеID хранилища
Полеdata.type Типstring ОписаниеТип объекта — всегда "file"
Полеdata.folderId Типnumber ОписаниеID родительской папки
Полеdata.deletedType Типnumber ОписаниеСтатус удаления: 0 — активен
Полеdata.globalContentVersion Типnumber ОписаниеСчётчик версий файла
Полеdata.fileId Типnumber ОписаниеВнутренний ID файла в Битрикс24
Полеdata.size Типnumber ОписаниеРазмер файла в байтах
Полеdata.createdBy Типnumber ОписаниеID пользователя-создателя
Полеdata.updatedBy Типnumber ОписаниеID пользователя, выполнившего переименование
Полеdata.deletedBy Типnumber|null ОписаниеID пользователя, удалившего файл. null — не удалён
Полеdata.createdAt Типstring ОписаниеДата и время создания (ISO 8601)
Полеdata.updatedAt Типstring ОписаниеДата и время переименования (ISO 8601)
Полеdata.deletedAt Типstring|null ОписаниеДата удаления. null — файл не удалён
Полеdata.contentProvider Типstring ОписаниеПоставщик контента (может отсутствовать)
Полеdata.realObjectId Типnumber ОписаниеВнутренний ID объекта
Полеdata.downloadUrl Типstring ОписаниеАдрес скачивания файла через API Вайбкод, GET /v1/files/:id/download. Запрос по нему передаёт заголовок X-Api-Key
Полеdata.detailUrl Типstring ОписаниеСсылка на файл в интерфейсе Битрикс24

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

JSON 
{
  "success": true,
  "data": {
    "id": 9251,
    "name": "doc-renamed.txt",
    "code": null,
    "storageId": 1,
    "type": "file",
    "folderId": 27,
    "deletedType": 0,
    "globalContentVersion": 1,
    "fileId": 34867,
    "size": 11,
    "createdBy": 1,
    "updatedBy": 1,
    "deletedBy": null,
    "createdAt": "2026-05-06T09:32:39.000Z",
    "updatedAt": "2026-05-26T07:08:50.000Z",
    "deletedAt": null,
    "downloadUrl": "https://vibecode.bitrix24.tech/v1/files/9251/download",
    "detailUrl": "https://example.bitrix24.ru/company/personal/user/1/disk/file/doc-renamed.txt/"
  }
}

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

404 — файл не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "diskFile 9251 not found"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеФайл с указанным id не существует
HTTP400 КодMISSING_FIELDS ОписаниеТело запроса не содержит поля name
HTTP400 КодREADONLY_FIELD ОписаниеВ теле передано поле только для чтения, например id или size
HTTP422 КодBITRIX_ERROR ОписаниеИмя уже занято в папке назначения. error.b24Code равен DISK_OBJ_22000. Выберите другое имя перед повтором
HTTP403 КодSCOPE_DENIED ОписаниеКлюч не имеет скоупа disk
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения — см. права доступа
HTTP401 КодTOKEN_MISSING ОписаниеКлюч не имеет настроенных токенов авторизации
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан: такой строки на платформе нет

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

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