Rename file

Changes the name of an existing file

Parameters

Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
FileID	--fileid	String, Number	✔	File identifier
Name	--title	String	✔	New folders name
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: disk.file.rename

1C:Enterprise/OneScript code example

    Name      = "New file name.jpg";
    Filename2 = "New file name 2.jpg";

    FileID2 = "46670";
    URL     = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";

    Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2);

    FileID = "46672";
    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "a5b00469006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token);

Bash

    oint bitrix24 RenameFile \
      --url "b24-ar17wx.bitrix24.by" \
      --fileid 57798 \
      --title "New file name.jpg" \
      --token "***"

CMD/Bat

    oint bitrix24 RenameFile ^
      --url "b24-ar17wx.bitrix24.by" ^
      --fileid 57798 ^
      --title "New file name.jpg" ^
      --token "***"

Result

{
 "result": {
  "ID": "57798",
  "NAME": "New file name.jpg",
  "CODE": null,
  "STORAGE_ID": "3",
  "TYPE": "file",
  "PARENT_ID": "3",
  "DELETED_TYPE": "0",
  "GLOBAL_CONTENT_VERSION": "1",
  "FILE_ID": "39850",
  "SIZE": "805189",
  "CREATE_TIME": "2026-05-26T14:11:41+00:00",
  "UPDATE_TIME": "2026-05-26T14:12:08+00:00",
  "DELETE_TIME": null,
  "CREATED_BY": "1",
  "UPDATED_BY": "1",
  "DELETED_BY": "0",
  "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=c2b7156a006e9f06006b12e400000001000007145daa5...",
  "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
 },
 "time": {
  "start": 1779804728,
  "finish": 1779804728.21312,
  "duration": 0.213119983673096,
  "processing": 0,
  "date_start": "2026-05-26T14:12:08+00:00",
  "date_finish": "2026-05-26T14:12:08+00:00",
  "operating_reset_at": 1779805328,
  "operating": 0
 }
}