Mark a Bookmark as Favorite

Purpose

This API is used to mark a specific bookmark as favourite.

OAuth Scope

Use the scope

ZohoMail.links.ALL (or) ZohoMail.links.UPDATE

to generate the Authtoken.

ALL - Grants full access to links.

UPDATE - Grants update access to links.

Request URL

Method: PUT

For Group :

https://mail.zoho.com/api/links/groups/{groupId}/{bookmarkId}/favorite

For Personal :

https://mail.zoho.com/api/links/me/{bookmarkId}/favorite

Path Parameters

groupId* long
- Specifies the unique ID of the group.
- This parameter can be retrieved from the Get all groups in Bookmarks API.
bookmarkId* long
- Specifies the unique ID of the bookmark.
- This parameter can be retrieved from the Get all bookmarks API.

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group

Copiedcurl "https://mail.zoho.com/api/links/groups/84626808/171204125579110001\favorite" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal Notes

Copiedcurl "https://mail.zoho.com/api/links/me/171204125579110001\favorite" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Success Response

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

Sample Failure Response

Copied{
  "data": {
    "errorCode": "INVALID_METHOD"
  },
  "status": {
    "code": 404,
    "description": "Invalid Input"
  }
}