Rename a Folder

Purpose

This API is used to rename a specific folder within a particular account.

OAuth Scope

Use the scope

ZohoMail.folders.ALL (or) ZohoMail.folders.UPDATE

to generate the Authtoken.

ALL - Full access to folders.

UPDATE - Rename a folder.

Request URL

Method: PUT

https://mail.zoho.com/api/accounts/{accountId}/folders/{folderId}

Path Parameters

  • accountId* long
    • This key is used to identify the account from which the folder has to be fetched. It is generated during account addition.
    • This parameter can be fetched from Get all accounts API.
  • folderId* long
    • This key is used to identify the folder to be renamed.
    • This parameter can be fetched from Get all folders API.

Request Body(JSON Object)

  • mode* string
    • This parameter specifies the type of operation that is to be performed.
    • Provide the value as rename.
  • folderName* string
    • This parameter refers to the new name of the folder.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/accounts/N****C0CM/folders/2******008001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d '{
    "mode":"rename",
    "folderName":"testnewupdate"
}'

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  }
}