Remove Labels from Emails

Purpose

This API is used to remove a specific labels from a particular email or a group of emails. 

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 removeLabel.
  • messageId* JSON Array of long 
    • This parameter should be passed as an array containing one or more message IDs for which labels needs to be removed. 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 for which labels needs to be removed. A thread ID is a unique identifier for an email thread.
      Note:If labels need to be removed for the entire thread, the threadId can be passed instead of the messageId.
    • This parameter can be retrieved from List Emails API.
  • labelId* JSON Array of long
    • This parameter should be passed as an array containing one or more label IDs for which are to be removed. A label ID is a unique identifier for a label.
    • This parameter can be retrieved from Get All Label Details 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":"removeLabel",
 "labelId":31321431,
 "messageId" : [11000000004001]
}'