Move Emails

Purpose

This API is used to move a particular email or a group of emails from the existing folder to a new folder.

OAuth Scope

Use the scope

ZohoMail.messages.ALL (or) ZohoMail.messages.UPDATE

to generate the Authtoken.

ALL - Grants full access to messages.

UPDATE - Grants access to update messages.

Request URL

Method: PUT

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

Path Parameters

Request Body (JSON object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as moveMessage.
  • messageId* JSON Array of long 
    • This parameter should be passed as an array containing one or more message IDs that need to be moved. A message ID is a unique identifier for an email.
    • This parameter can be retrieved from List Emails API.
  • threadId JSON Array of long 
    • This parameter should be passed as an array containing one or more thread IDs that need to be moved. A thread ID is a unique identifier for an email thread.
      Note: In case the entire thread need to be moved, threadId can be passed instead of messageId.
    • This parameter can be retrieved from List Emails API.
  • destfolderId* long 
    • This parameter is the unique identifier of the folder to which the email(s) need to be moved.
    • This parameter can be retrieved from Get All Folders API.
  • isFolderSpecific boolean
    • This parameter specifies whether this action is folder-specific.
    • Allowed values:
      • true - If true, folderId has to be mentioned.
      • false
    • The default value is false.
  • folderId long 
    • This parameter is the unique identifier for the existing folder.
    • This parameter can be retrieved from Get All Folders API.
  • isArchive boolean
    • This parameter specifies whether archived emails should be included in this action.
    • Allowed values:
      • true - The move action will include both archived and non-archived emails.
      • false - The move action will exclude archived emails, applying only to non-archived emails.
    • The default value is false.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/accounts/12345678/updatemessage" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d ' {  
 "mode":"moveMessage",
 "destfolderId":134143131,
 "messageId" : [11000000004001]
}'

Sample Response

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