Update a folder

PUT /api/2.0/mail/userfolders/{id}

Request

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

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

idintegerformat: uint32

Folder ID

Body

namestring

New folder name

parentIdarray of integer

New parent folder ID (root level is equal to 0)

Examples

PUT /api/2.0/mail/userfolders/%7Bid%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/mail/userfolders/%7Bid%7D \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Folder information

Idintegerformat: uint32

ParentIdintegerformat: uint32

Namestring

UnreadCountintegerformat: int32

TotalCountintegerformat: int32

UnreadChainCountintegerformat: int32

TotalChainCountintegerformat: int32

FolderCountintegerformat: int32

401

Unauthorized