Mark Folder as Read

Purpose

This API is used to mark a specific folder in a specific account as read.

OAuth Scope

Use the scope

ZohoMail.folders.ALL (or) ZohoMail.folders.UPDATE

to generate the Authtoken.

ALL - Full access to folders.

UPDATE - Update folder status as read.

Request URL

Method: PUT

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

Path Parameters

  • accountId* long
    • This key is used to identify the account from which the folder have to be fetched. It is generated during account addition.
    • This parameter can be fetched from Get all accounts API.
  • folderId* long
    • This key is used to identify the folder to be marked as read.
    • This parameter can be fetched from Get all folders API.

Request Body(JSON Object)

  • mode* string
    • This parameter specifies the type of operation that is to be performed.
    • Provide the value as markAsRead.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/accounts/N7A8**0CM/folders/2356***08001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ****" \
-d '{
    "mode":"markAsRead"
}'

Sample Response

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