PUT - Apply Label to Thread(s)

Purpose

This API is used to apply label to single or multiple threads.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to messages.

UPDATE - Update messages.

Request URL

Method : PUT

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

Path Parameters

  • accountId* long
    • This is the unique identifier for a particular user account.
    • This parameter can be fetched from User Account Details API.

Request Body (JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as applyLabel.
  • threadId* JSON Array of long values
    • This parameter should be passed as an array of single or multiple thread IDs that need to be labelled.
    • threadId is a unique identifier assigned to a thread.
  • labelId* JSON Array of long values
    • This parameter should be passed as an array of single or multiple label IDs that need to be applied.
    • labelId is a unique identifier assigned to a label.
  • isArchive boolean
    • This parameter indicates whether the threads to be labelled are archived or not.
    • The possible value can be
      • true - If the email threads are archived.
      • false - If the email threads are not archived.
  • isFolderSpecific boolean
    • This parameter specifies whether the threads to be labelled are folder specific or not.
    • The value can be
      • true - If folder specific.
      • false - If not folder specific
  • folderId string
    • This is the ID of the folder whose email threads needs to be labelled.
    • This is a mandatory parameter if the 'isFolderSpecific' parameter has the value 'true'.

 

* - Mandatory parameter.

Response Codes

Refer here for the response codes and their meaning.

Sample Request Body

Copied{
    "mode": "applyLabel",
    "labelId": [
        3132143165367
    ]
    "threadId": [
        31321431
    ]
}