Get Started
Usage API
More information

PUT api/2.0/mail/userfolders/{id} This function requires authentication

Description

Updates a user folder with the parameters specified in the request.

Parameters
Name Description Type Example
id
sent in url
Folder ID number 1234
name
sent in body
New folder name string some text
parentId
sent in body
New parent folder ID (root level is equal to 0)
optional
number 1234
Example
PUT api/2.0/mail/userfolders/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "parentId": 1234
}
Returns

Folder information

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": 1234,
    "parent": 1234,
    "name": "name",
    "unread_count": 123,
    "total_count": 123,
    "unread_chain_count": 123,
    "total_chain_count": 123,
    "folder_count": 123
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>1234</id>
    <parent>1234</parent>
    <name>name</name>
    <unread_count>123</unread_count>
    <total_count>123</total_count>
    <unread_chain_count>123</unread_chain_count>
    <total_chain_count>123</total_chain_count>
    <folder_count>123</folder_count>
  </response>
</result>