Label Threads
Purpose
This API is used to apply single/multiple labels to single or multiple threads simultaneously.
OAuth Scope
Use the scope
MailApps.messages.ALL (or) MailApps.messages.UPDATE
ALL - Full access to the messages.
UPDATE - Label threads.
To generate Authtoken, refer here.
Request URL
Method: PUT
https://mail360.zoho.com/api/accounts/{account_key}/threads
Path Parameters
- account_key* string
- This key is used to identify the account in which the threads have to be updated. It is generated during account addition.
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
- This parameter needs to be passed as an array of single or multiple thread IDs which has to be labelled.
- threadId is a unique identifier assigned to a thread.
- labelId* JSON Array of long
- This parameter needs to be passed as an array of single or multiple label IDs which has to be applied.
- labelId is a unique identifier assigned to a label.
* - Mandatory parameter
Note:
While the Messages APIs focus on individual messages, the Threads APIs deal with entire conversation threads, each of which contains multiple messages.
Sample Request
Copied
Sample Success Response
Copied
Sample Failure Response
Copied