Rename file

Changes the name of an existing file

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

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 = "19570";
    URL     = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";

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

    FileID = "19572";
    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "2f4e4067006e9f06006b12e400000001000...";

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

Bash
CMD/Bat

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

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

Result
{
 "result": {
  "ID": "12576",
  "NAME": "New file name.jpg",
  "CODE": null,
  "STORAGE_ID": "3",
  "TYPE": "file",
  "PARENT_ID": "3",
  "DELETED_TYPE": "0",
  "GLOBAL_CONTENT_VERSION": "1",
  "FILE_ID": "8666",
  "SIZE": "805189",
  "CREATE_TIME": "2024-10-09T09:20:02+03:00",
  "UPDATE_TIME": "2024-10-09T09:20:02+03:00",
  "DELETE_TIME": null,
  "CREATED_BY": "1",
  "UPDATED_BY": "1",
  "DELETED_BY": "0",
  "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz0wWFJ4WFEzM0FGTTdMWlZ5WmdqRU90ZG15QVd3MlJqeQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHowd1dGSjRXRkV6TTBGR1RUZE1XbFo1V21kcVJVOTBaRzE1UVZkM01sSnFlUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.QkRL4GgBhO%2FJVenu5%2Fn%2BxllOXMyOOL1HhrapYtzpnY4%3D",
  "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
 },
 "time": {
  "start": 1728454823.17663,
  "finish": 1728454823.22042,
  "duration": 0.043795108795166,
  "processing": 0.0184369087219238,
  "date_start": "2024-10-09T09:20:23+03:00",
  "date_finish": "2024-10-09T09:20:23+03:00",
  "operating_reset_at": 1728455423,
  "operating": 0
 }
}