Mark a Note as Favourite

Purpose

This API is used to mark a note as favorite.

OAuth Scope

Use the scope

ZohoMail.notes.ALL (or) ZohoMail.notes.UPDATE

to generate the Authtoken.

ALL - Grants full access to notes.

UPDATE - Grants access to update notes.

Request URL

Method: PUT

Group Notes :

https://mail.zoho.com/api/notes/groups/{groupId}/{noteId}/favorite

or

Personal Notes :

https://mail.zoho.com/api/notes/me/{noteId}/favorite

Path Parameters

  • groupId* long
    • Specifies the unique ID of the group.
    • This parameter can be retrieved from the Get all groups API.
  • noteId* long
    • Specifies the unique ID of the note which is to be marked as favourite.
    • This parameter can be retrieved from the Get all notes API.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Group Notes

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

Sample Request - Personal Notes

Copiedcurl "https://mail.zoho.com/api/notes/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": "URL_RULE_NOT_CONFIGURED"
  },
  "status": {
    "code": 404,
    "description": "Invalid Input"
  }
}