Create a Bookmark

Purpose

This API is used to create/add a new bookmark.

OAuth Scope

Use the scope

ZohoMail.links.ALL (or) ZohoMail.links.CREATE

to generate the Authtoken.

ALL - Grants full access to links.

CREATE - Grants access to create bookmarks in links.

Request URL

Method: POST

Group Bookmarks:

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

or

Personal Bookmarks:

https://mail.zoho.com/api/links/me

Path Parameters

Request Body (JSON Object)

  • link* string
    • Provide the link that you want to add as a bookmark.
  • tiltle* string
    • Provide the title for the bookmark being added.
  • summary string
    • Provide a summary for the bookmark being added
  • 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" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "summary": "Link Description",
 "link": "https://www.zoho.com",
 "title": "zoho link"
}'

Sample Request - For Personal

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

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "entityId": "1712055358708110001",
    "URI": "https://mail.zoho.com/api/links/groups/123456789/1712055358708110001"
  }
}

Sample Failure Response

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