Move Folder

Purpose

This API serves the purpose of relocating a specific folder to a new parent folder.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to folders.

UPDATE - Move 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 folders have 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 that needs to be relocated.
    • 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 move.
  • parentFolderId long
    • This parameter refers to the folder ID of the destination parent folder where the folder should be moved.
  • previousFolderId long
    • This parameter refers to the folder ID of a specific folder under the destination parent folder. This determines the exact position where the folder should be placed.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/accounts/N7**CM/folders/235670****8001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
    "mode":"move",
    "parentFolderId":"2356***02050"
}'

Sample Response

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