Get Started
Usage API
More information

PUT api/2.0/files/folder/{folderId} This function requires authentication

Description

Renames the selected folder with a new title specified in the request.

Parameters
Name Description Type Example
folderId
sent in url
Folder ID string some text
title
sent in body
New folder title string some text
Example
PUT api/2.0/files/folder/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text"
}
Returns

Folder contents

Example Response

application/json

{
  "status": 0,
  "response": {
    "RootFolderType": 2,
    "UpdatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Created": "2020-12-13T17:13:31.5902727Z",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Updated": "2020-12-13T17:13:31.5902727Z",
    "ProviderItem": true,
    "ProviderKey": "1234d",
    "ProviderId": 1234,
    "ParentId": 1840746475,
    "FilesCount": 1840746475,
    "FoldersCount": 1840746475,
    "IsShareable": true,
    "Id": 857864274,
    "Title": "Some titile.txt",
    "Access": 1,
    "Shared": false
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <RootFolderType>2</RootFolderType>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <Created>2020-12-13T17:13:31.5902727Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <Updated>2020-12-13T17:13:31.5902727Z</Updated>
    <ProviderItem>True</ProviderItem>
    <ProviderKey>1234d</ProviderKey>
    <ProviderId>1234</ProviderId>
    <ParentId>1840746475</ParentId>
    <FilesCount>1840746475</FilesCount>
    <FoldersCount>1840746475</FoldersCount>
    <IsShareable>True</IsShareable>
    <Id>857864274</Id>
    <Title>Some titile.txt</Title>
    <Access>1</Access>
    <Shared>False</Shared>
  </response>
</result>