Edit a Bookmark

Purpose

This API is used to edit the details of a specific bookmark.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to links.

UPDATE - Grants access to update links.

Request URL

Method: PUT

For Group :

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

or

For Personal :

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

Path Parameters

  • groupId* long
    • Specifies the unique ID of the group.
    • This parameter can be retrieved from the Get all groups API.
  • bookmarkId* long

Request Body (JSON Object)

  • link* string
    • Provide the updated link of the bookmark.
  • tiltle* string
    • Provide the updated title of the bookmark .
  • summary string
    • Provide the updated summary of the bookmark.
  • collectionId string
    • Specify the unique ID of collection you want to add the bookmark to.
    • This parameter can be retrieved from the Get all collections 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/123456789/171204125579110001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "summary": "new Link Description",
 "link": "https://www.zoho.com",
 "title": "new zoho link"
}'

Sample Request - For Personal

Copiedcurl "https://mail.zoho.com/api/links/me/171204125579110001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "summary": "new Link Description",
 "link": "https://www.zoho.com",
 "title": " new zoho link"
}'

Sample Success Response

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

Sample Failure Response

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