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

PATCH /v1/files/:id

Переименовывает файл на диске. Принимает только поле name — остальные поля файла остаются без изменений, расположение файла не меняется.

#Поля запроса (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 Ссылка для скачивания файла
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://example.bitrix24.ru/disk/downloadFile/34867/?...",
    "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 Код Описание
404 ENTITY_NOT_FOUND Файл с указанным id не существует
400 MISSING_FIELDS Тело запроса не содержит поля name
403 SCOPE_DENIED Ключ не имеет скоупа disk
401 TOKEN_MISSING Ключ не имеет настроенных токенов авторизации
401 INVALID_API_KEY Неверный или просроченный API-ключ

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

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