Mark Emails As Spam

Purpose

This API is used to mark a particular email or a group of emails as spam.

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 moveToSpam.
  • messageId* JSON Array of long 
    • This parameter should be passed as an array containing one or more message IDs which should be marked as spam. 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 which should be marked as spam. A thread ID is a unique identifier for an email thread.
      Note: In case the entire thread needs to be marked as spam, threadId can be passed instead of messageId.
    • This parameter can be retrieved from List Emails 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 of the respective folder. Only messages that are present in this folder will be considered for this action.
    • This parameter can be retrieved from Get All Folders API.

 

* - 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": "moveToSpam",
 "messageId": [1716466818827107400]
}

Sample Response

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