Notes API Details
The Notes API facilitates retrieving notes assigned to you, those added to a group, and more. It supports tasks such as adding, managing notes, creating books, and marking notes as favorites.
While using any API related to Notes, make use of the OAuth scope Zohomail.notes.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Create a note | Group Notes: /api/notes/groups/{groupId} | POST | ZohoMail.notes | To add a new note. |
| Personal Note: /api/notes/me | ||||
| Create a book | Group Notes /api/notes/groups/{groupId}/books | POST | To add a new book in Notes. | |
| Personal Notes: /api/notes/me/books | ||||
| Add an attachment to a note | Group Notes: /api/notes/groups/{groupId}/{noteId}/attachments | POST | To add attachments to a note. | |
| Personal Notes: /api/notes/me/{noteId}/attachments | ||||
| Get all groups | /api/notes/groups | GET | To get all group details. | |
| Get all notes | Group Notes: /api/notes/groups/{groupId} | GET | To get details of all the notes. | |
| Personal Notes: /api/notes/me | ||||
| Get all books | Group Notes /api/notes/groups/{groupId}/books | GET | To list all the books in Notes. | |
| Personal Notes: /api/notes/me/books | ||||
| Get all favourite notes | /api/notes/favorites | GET | To get all favorite notes details. | |
| Get all shared notes | /api/notes/sharedtome | GET | To get all shared notes details. | |
| Get all notes in a book | Group Notes: /api/notes/groups/{groupId}/books/{bookId} | GET | To get details of all notes in a Book. | |
| Personal Notes: /api/notes/me/books/{bookId} | ||||
| Get all attachments in a note | Group Notes: /api/notes/groups/{groupId}/{noteId}/attachments | GET | To get details of all attachments in a note. | |
| Personal Notes: /api/notes/me/{noteId}/attachments | ||||
| Get a note | Group Notes: /api/notes/groups/{groupId}/{noteId} | GET | To get details of a single note. | |
| Personal Note: /api/notes/me/{noteId} | ||||
| Get an attachment | Group Notes: /api/notes/groups/{groupId}/{noteId}/attachments/{attachmentId} | GET | To get details of an attachment in a note. | |
| Personal Notes: /api/notes/me/{noteId}/attachments/{attachmentId} | ||||
| Edit a note | Group Notes: /api/notes/groups/{groupId}/{noteId} | PUT | To edit a note. | |
| Personal note: /api/notes/me/{noteId} | ||||
| Edit a book | Group Notes: /api/notes/groups/{groupId}/books/{bookId} | PUT | To edit a book in Notes. | |
| Personal note: /api/notes/me/books/{bookId} | ||||
| Mark a note as favorite | Group Notes: /api/notes/groups/{groupId}/{noteId}/favorite | PUT | To mark a note as favorite. | |
| Personal Notes: /api/notes/me/{noteId}/favorite | ||||
| Unmark a note as favorite | Group Notes: /api/notes/groups/{groupId}/{noteId}/favorite | DELETE | To remove favorite mark from a note. | |
| Personal Notes: /api/notes/me/{noteId}/favorite | ||||
| Delete an attachment | Group notes; /api/notes/groups/{groupId}/{noteId}/attachments/{attachmentId} | DELETE | To delete an attachment in a note. | |
| Personal Notes /api/notes/me/{noteId}/attachments/{attachmentId} | ||||
| Delete a book | Group Notes: /api/notes/groups/{groupId}/books/{bookId} | DELETE | To delete a book in Notes. | |
| Personal Notes: /api/notes/me/books/{bookId} | ||||
| Delete a note | Group Notes; /api/notes/groups/{groupId}/{noteId} | DELETE | To delete a note. | |
| Personal Notes: /api/notes/me/{noteId} |