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

メールフォルダ名を変更する。

  • システムメールフォルダ (folderId が 100 以下の場合) は、名前の変更はできない。
  • 階層化されている下位フォルダの名前を変更する場合、指定するメールフォルダ名に上位のメールフォルダが含まれなければ、階層構造が維持されない。
    例えば、以下の階層構造で ChildFolder メールフォルダ名を変更する場合、リクエストパラメータの folderName は "ParentFolder/newChildFolder" と指定する。
ParentFolder  ChildFolder

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

mail

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • 自身 ("me")

required
example : me 
folderId string 

メールフォルダ 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 

メールフォルダ名


required
minLength : 1
maxLength : 100 

Request Example

example

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

Response

HTTP 200

OK

PropertyTypeDescription
folderName string 

メールフォルダ名


required
minLength : 1 
folderId integer 

メールフォルダ ID


required
format : int32 

Response Example

example

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