Bookmarks API Details
The Bookmarks API helps you perform various actions on personal/ group bookmarks like adding/ deleting a new bookmark, creating a collection, marking a bookmark as favorite etc
While using any API related to Bookmarks, make use of the OAuth scope ZohoMail.links.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Create a bookmark | Group Bookmarks: /api/links/groups/{groupId} | POST | ZohoMail.links | To create a new bookmark. |
| Personal Bookmarks: /api/links/me | ||||
| Create a collection | Group Bookmarks: /api/links/groups/{groupId}/collections | POST | To create a new collection. | |
| Personal Bookmarks: /api/links/me/collections | ||||
| Get all groups | /api/links/groups | GET | To get all group details. | |
| Get all bookmarks | Group Bookmarks: /api/links/groups/{groupId} | GET | To get details of all the bookmarks in group/personal. | |
| Personal Bookmarks: /api/links/me | ||||
| Get all favorite bookmarks | /api/links/favorites | GET | To get all favorite bookmarks. | |
| Get all shared bookmarks | /api/links | GET | To get all shared bookmarks. | |
| Get all bookmarks in trash | Group Bookmarks: /api/links/groups/{groupId}/trash | GET | To get all bookmarks in trash | |
| Personal Bookmarks: /api/links/me/trash | ||||
| Get all collections | Group Bookmarks: /api/links/groups/{groupId}/collections | GET | To get all collections. | |
| Personal Bookmarks: /api/links/me/collections | ||||
| Get all collections in groups | /api/links/groups/collections | GET | To get all collections of all groups. | |
| Get all bookmarks in a collection | Group Bookmarks: /api/links/groups/{groupId}/collections/{collectionId} | GET | To get all bookmarks in a collections. | |
| Personal Bookmarks: /api/links/me/collections/{collectionId} | ||||
| Get a bookmark | Group Bookmarks: /api/links/groups/{groupId}/{bookmarkId} | GET | To get details of a single bookmark | |
| Personal Bookmarks: /api/links/me/{bookmarkId} | ||||
| Edit a bookmark | Group Bookmarks: /api/links/groups/{groupId}/{bookmarkId} | PUT | To edit a bookmark. | |
| Personal Bookmarks: /api/links/me/{bookmarkId} | ||||
| Restore a bookmark | /api/links/groups/{groupId}/{bookmarkId}/restore | PUT | To restore a bookmark. | |
| Edit a collection | Group Bookmarks: /api/links/groups/{groupId}/collections/{collectionId} | PUT | To edit a collection. | |
| Personal Bookmarks: /api/links/me/collections/{collectionId} | ||||
| Mark a Bookmark as favorite | Group Bookmarks: /api/links/groups/{groupId}/{bookmarkId}/favorite | PUT | To mark a bookmark as favorite. | |
| Personal Bookmarks: /api/links/me/{bookmarkId}/favorite | ||||
| Unmark a bookmark as favorite | Group Bookmarks: /api/links/groups/{groupId}/{bookmarkId}/favorite | DELETE | To unmark a bookmark as favorite. | |
| Personal Bookmarks: /api/links/me/{bookmarkId}/favorite | ||||
| Delete a bookmark | Group Bookmarks: /api/links/groups/{groupId}/{bookmarkId} | DELETE | To delete a bookmark. | |
| Personal Bookmarks: /api/links/me/{bookmarkId} | ||||
| Delete a collection | Group Bookmarks: /api/links/groups/{groupId}/collections/{collectionId} | DELETE | To delete a collection. | |
| Personal Bookmarks: /api/links/me/collections/{collectionId} |