PUT/users/{userId}/mail/mailfolders/{folderId}

Renames a specified folder.

Caution

  • System folders whose folderIds are less than 100 cannot be renamed.
  • To rename a child folder in a hierarchical structure, the new child folder name must include the parent folder name. For example, if you want to rename ChildFolder in the following structure, you should set "ParentFolder/newChildFolder" for folderName.
ParentFolder   ChildFolder

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

mail

HTTP Request

PUThttps://www.worksapis.com/v1.0/users/{userId}/mail/mailfolders/{folderId}

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • User ID
  • Login ID (email)
  • Me

required
example : me 
folderId string 

Folder ID


required
example : 1 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
folderName string 

Folder name


required
minLength : 1
maxLength : 100 

Request Example

example

1{2  "folderName": "newFolderName"3}

Response

HTTP 200

OK

PropertyTypeDescription
folderName string 

Folder name


required
minLength : 1 
folderId integer 

Folder ID


required
format : int32 

Response Example

example

1{2  "folderId": 10001,3  "folderName": "test"4}