API Guide Index

‚ÄčOrganization API

Method NameMethod TypeURLOAuth ScopeOperation
Add Child OrganizationPOST/api/organization/ZohoMail.partner.organizationCREATE
Get Organization Details GET/api/organization/{zoid}READ
Get Org Subscription DetailsGET/api/organization/{zoid}/storageZohoMail.organization.subscriptionsREAD
Get User Storage DetailsGET/api/organization/{zoid}/storage/{zuid}READ
Update User StoragePUT/api/organization/{zoid}/storage/{zuid}UPDATE
Update Org Spam Process TypePUT/api/organization/{zoid}ZohoMail.partner.organizationUPDATE
Get Org Spam ListingGET/api/organization/{zoid}/antispam/dataZohoMail.organization.spamREAD
Add Org Spam ListingPUT/api/organization/{zoid}/antispam/dataUPDATE
Remove Org Spam ListingDELETE/api/organization/{zoid}/antispam/dataDELETE
Add Allowed IPsPOST/api/organization/{zoid}/allowedIpsZohoMail.organization.accountsCREATE
Get Allowed IPs ListGET/api/organization/{zoid}/allowedIpsREAD
Delete Allowed IPsDELETE/api/organization/{zoid}/allowedIpsDELETE

Domain API

Method NameMethod TypeURLOAuth ScopeOperation
All Domain Details GET/api/organization/<zoid>/domainsZohoMail.organization.domainsREAD
Single Domain DetailsGET/api/organization/<zoid>/domains/<domainname>READ
Add Domain to an Organization POST/api/organization/<zoid>/domainsCREATE
Verify a Domain in the Organization PUT/api /organization/<zoid>/domainsUPDATE
Make a Domain as PrimaryPUT/api/organization/<zoid>/domainsUPDATE
Enable Email Hosting for a Domain PUT/api/organization/<zoid>/domainsUPDATE
Disable Email Hosting for a DomainPUT/api/organization/<zoid>/domainsUPDATE
Make a Domain as an Alias DomainPUT/api/organization/<zoid>/domainsUPDATE
Remove a Domain from Domain AliasPUT/api/organization/<zoid>/domainsUPDATE
Delete a Domain from the Organization DELETE/api/organization/<zoid>/domainsDELETE

Groups API

Method NameMethod TypeURLOAuth ScopeOperation
Create a groupPOST/api/organization/{zoid}/groupsZohoMail.organization.groupsCREATE
Get all group detailsGET/api/organization/{zoid}/groupsREAD
Get specific group detailsGET/api/organization/{zoid}/groups/{zgid}READ
Get all emails held for moderationGET/api/organization/{zoid}/groups/{zgid}/messagesREAD
Get moderation email contentGET/api/organization/{zoid}/groups/{zgid}/messages/{messageId}READ
Moderate emails in a groupPUT/api/organization/{zoid}/groups/{zgid}/messagesUPDATE
Update group namePUT/api/organization/{zoid}/groups/{zgid}UPDATE
Enable streams for a groupPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Add group membersPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Delete group membersPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Update member statusPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Update member rolePUT/api/organization/{zoid}/groups/{zgid}UPDATE
Update member settingsPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Update threshold limitPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Update advanced admin settingsPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Add group email aliasPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Remove group email aliasPUT/api/organization/{zoid}/groups/{zgid}UPDATE
Delete groupDELETE/api/organization/{zoid}/groups/{zgid} or 
/api/organization/{zoid}/groups
DELETE

Users API

Method NameMethod TypeURLOAuth ScopeOperation
All Users Mail Account Details GET/api/organization/<zoid>/accounts/ZohoMail.organization.accountsREAD
Single User DetailsGET/api/organization/<zoid>/accounts/<accountid>READ
Add User Account to an OrganizationPOST/api/organization/<zoid>/accounts/CREATE
Change the role of a UserPUT/api/organization/<zoid>/accounts/<accountid>UPDATE
Reset the password of a UserPUT/api/organization/<zoid>/accounts/<accountid>UPDATE
Add an email Alias to the User AccountPUT/api/organization/<zoid>/accounts/<accountid>UPDATE
Delete an email Alias from the User AccountPUT/api/organization/<zoid>/accounts/<accountid>UPDATE
To enable the User's Mail AccountPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
To disable the User's Mail AccountPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
To change Incoming StatusPUT/api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
To change Outgoing StatusPUT/api/organization/<zoid>/accounts/<accountid>UPDATE
To change IMAP StatusPUTAdmin Authentication: /api/organization/<zoid>/accounts/ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
To change POP StatusPUTAdmin Authentication: /api/organization/<zoid>/accounts/ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
To change ActiveSync StatusPUT/api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
To change TFA PreferencePUT/api/organization/<zoid>/accounts/<accountid>UPDATE
To Enable UserPUT/api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
To Disable UserPUT/api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE

Accounts API

Method NameMethod TypeURLOAuth ScopeOperation
User Account DetailsGET/api/accountsZohoMail.accountsREAD
Update Mail Account Sequence PUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Reply To AddressPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Resend Verification for Reply To AddressPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Add Send Mail DetailsPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Send Mail AddressPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Display Name and Email AddressPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Display NamePUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Email AddressPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Add Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Verify Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Enable Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Resend Verification for Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Disable Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Delete Zoho Mail copy in Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Delete Email ForwardingPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Add Vacation ReplyPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Update Vacation ReplyPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts
Remove Vacation ReplyPUTAdmin Authentication: /api/organization/<zoid>/accounts/<accountid>ZohoMail.organization.accountsUPDATE
User Authentication: /api/accounts/<accountid>ZohoMail.accounts

Folders API

Method NameMethod TypeURLOAuth ScopeOperation
Create a new folderPOST/api/accounts/{accountId}/foldersZohoMail.foldersCREATE
Get all FoldersGET/api/accounts/{accountId}/foldersREAD
Get specific folderGET/api/accounts/{accountId}/folders/{folderId}READ
Rename folderPUT/api/accounts/{accountId}/folders/{folderId}UPDATE
Move folderPUT/api/accounts/{accountId}/folders/{folderId}UPDATE
Enable IMAP view for folderPUT /api/accounts/{accountId}/folders/{folderId}UPDATE
Disable IMAP view for folderPUT/api/accounts/{accountId}/folders/{folderId}UPDATE
Mark folder as readPUT/api/accounts/{accountId}/folders/{folderId}UPDATE
Empty folderPUT/api/accounts/{accountId}/folders/{folderId}UPDATE
Delete folderDELETE/api/accounts/{accountId}/folders/{folderId}DELETE

Label API

Method NameMethod TypeURLOAuth ScopeOperation
Get all Label DetailsGET/api/accounts/<accountId>/labelsZohoMail.tagsREAD
Get Details of a Single LabelGET/api/accounts/<accountId>/labels/<labelid>READ
Create a new LabelPOST/api/accounts/<accountId>/labelsCREATE
Update a LabelPUT/api/accounts/<accountId>/labels/<labelid>UPDATE
Delete a LabelDELETE/api/accounts/<accountId>/labels/<labelid>DELETE

Email Messages API

Method NameMethod TypeURLOAuth ScopeOperation
List of emails in a folderGET/api/accounts/<accountId>/messages/viewZohoMail.messagesREAD
List search results GET/api/accounts/<accountId>/messages/searchREAD
Get meta data of an emailGET/api/accounts/<accountId>/folders/folderid/messages/<messageId>/detailsREAD
Get attachment infoGET/api/accounts/<accountId>/folders/folderId/messages/<messageId>/attachmentinfoREAD
Get email contentGET/api/accounts/<accountId>/folders/folderId/messages/<messageId>/contentREAD
Get email headersGET/api/accounts/<accountId>/folders/folderId/messages/<messageId>/headerREAD
Mark emails as readPUT/api/accounts/<accountId>/updatemessageUPDATE
Send an emailPOST/api/accounts/<accountId>/messagesCREATE
Send an email with attachmentPOST/api/accounts/<accountId>/messagesCREATE

Signatures API

Method NameMethod TypeURLOAuth ScopeOperation
Add user signaturePOST/api/accounts/signatureZohoMail.accountsCREATE
Get user signatureGET/api/accounts/signatureREAD
Update user signaturePUT/api/accounts/signatureUPDATE
Delete user signatureDELETE/api/accounts/signatureDELETE

Threads API

Method NameMethod TypeURLOAuth ScopeOperation
Flag threadPUT/api/accounts/{accountId}/updatethreadZohoMail.messagesUPDATE
Move threadPUT/api/accounts/{accountId}/updatethreadUPDATE
Apply Label to thread PUT/api/accounts/{accountId}/updatethreadUPDATE
Remove label from thread PUT/api/accounts/{accountId}/updatethreadUPDATE
Remove all labels from thread PUT/api/accounts/{accountId}/updatethreadUPDATE
Mark thread as readPUT/api/accounts/{accountId}/updatethreadUPDATE
Mark thread as unreadPUT/api/accounts/{accountId}/updatethreadUPDATE
Mark thread as spamPUT/api/accounts/{accountId}/updatethreadUPDATE
Mark thread as not spamPUT/api/accounts/{accountId}/updatethreadUPDATE

Tasks API

Method NameMethod TypeURLOAuth ScopeOperation
Get all Tasks in a GroupGET/api/tasks/groups/<GroupID>ZohoMail.tasksREAD
Get personal TasksGET/api/tasks/meREAD
Get all Tasks asigned to youGET/api/tasks?view=assignedtome&action=viewREAD
Get all Tasks created by youGET/api/tasks?view=createdbyme&action=viewREAD
Get single TaskGETGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
READ
Personal Tasks: 
/api/tasks/me/<entityId>
Get all subtasksGETGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>/subtasks
READ
Personal Tasks: 
/api/tasks/me/<entityId>/subtasks
Get all Tasks in a specific projectGET/api/tasks/groups/<GroupID>/projects/<projectId>READ
Get all Tasks with given statusGET/api/tasks/groups/<GroupID>/?status=<Status>READ
Add a new group TaskPOST/api/tasks/groups/<GroupID>CREATE
Add a new personal TaskPOST/api/tasks/meCREATE
Change Task titlePUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks:
/api/tasks/me/<entityId
Change Task descriptionPUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Change Task priorityPUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Change Task statusPUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Change Task projectPUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Change Task assigneePUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Set/ change Task due datePUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Set/ change Task ReminderPUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Set/ change Task reminder based on Due DatePUTGroup Tasks: 
/api/tasks/groups/<GroupID>/<entityId>
UPDATE
Personal Tasks: 
/api/tasks/me/<entityId
Change or set recurring TaskPUTGroup Tasks:
/api/tasks/groups/<GroupID>/<entityId>?
UPDATE
Personal Tasks:
/api/tasks/me/<entityId>?
Delete a group TaskDELETE/api/tasks/groups/<GroupID>/<entityId>DELETE
Delete a Task assigned to you/ created by youDELETE/api/tasks/<entityId>DELETE
Get all projects in a groupGET/api/tasks/groups/<groupId>/projectsREAD
Get all Tasks in a project with a given statusGET/api/tasks/groups/<GroupID>/projects/<projectId>?status=<Status>READ
Add a new projectPOST/api/tasks/groups/<groupId>/projects?CREATE
Edit a projectPUT/api/tasks/groups/<groupId>/projects/<projectId>UPDATE
Delete a projectDELETE/api/tasks/groups/<groupId>/projects/<projectId>DELETE
Get all groupsGET/api/tasks/groupsREAD
Get member details in a groupGET/api/tasks/groups/<GroupId>/membersREAD

Bookmarks API

Method NameMethod TypeURLOAuth ScopeOperation
Get all GroupsGET/api/links/groupsZohoMail.linksREAD
Get all BookmarksGETGroup Bookmarks:
/api/links/groups/<groupid>
READ
Personal Bookmarks: 
/api/links/me
Add a new BookmarkPOSTGroup Bookmarks:
/api/links/groups/<groupid>
CREATE
Personal Bookmarks: 
/api/links/me
Get a BookmarkGETGroup Bookmarks: 
/api/links/groups/<groupid>/<entityId>
READ
Personal Bookmarks: 
/api/links/me/<entityId>
Edit a BookmarkPUTGroup Bookmarks: 
/api/links/groups/<groupid>/<entityId>
UPDATE
Personal Bookmarks: 
/api/links/me/<entityId>
Mark a Bookmark as favoritePUTGroup Bookmarks: 
/api/links/groups/<groupid>/<entityId>/favorite
UPDATE
Personal Bookmarks: 
/api/links/me/<entityId>/favorite
Unmark a Bookmark as favoritesDELETEGroup Bookmarks: 
/api/links/groups/<groupid>/<entityId>/favorite
DELETE
Personal Bookmarks: 
/api/links/me/<entityId>/favorite
Delete a BookmarkDELETEGroup Bookmarks: 
/api/links/groups/<groupid>/<entityId>
DELETE
Personal Bookmarks: 
/api/links/me/<entityId>
Get all collectionsGETGroup Bookmarks: 
/api/links/groups/<groupid>/collections
READ
Personal Bookmarks: 
/api/links/me/collections
Create a collectionPOSTGroup Bookmarks: 
/api/links/groups/<groupid>/collections
CREATE
Personal Bookmarks: 
/api/links/me/collections
Edit a collectionPUTGroup Bookmarks: 
/api/links/groups/<groupid>/collections/<collectionId>
UPDATE
Personal Bookmarks: 
/api/links/me/collections/<collectionId>
Delete a collectionDELETEGroup Bookmarks: 
/api/links/groups/<groupid>/collections/<collectionId>
DELETE
Personal Bookmarks: 
/api/links/me/collections/<collectionId>
Get all Bookmarks in a collectionGETGroup Bookmarks: 
/api/links/groups/<groupid>/collections/<collectionId>
READ
Personal Bookmarks: 
/api/links/me/collections/<collectionId>

Notes API

Method NameMethod TypeURLOAuth ScopeOperation
Get all groupsGET/api/notes/groupsZohoMail.notesREAD
Get all NotesGETGroup Notes:
/api/notes/groups/<groupid>
READ
Personal Notes: 
/api/notes/me
Create a NotePOSTGroup Notes:
/api/notes/groups/<groupid>
CREATE
Personal Note: 
/api/notes/me
Get a NoteGETGroup Notes:
/api/notes/groups/<groupid>/<entityId>
READ
Personal Note: 
/api/notes/me/<entityId>
Edit a notePUTGroup Notes:
/api/notes/groups/<groupid>/<entityId>
UPDATE
Personal Note: 
/api/notes/me/<entityId>
Get attachments in a noteGETGroup Notes:
/api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId>
READ
Personal Note: 
/api/notes/me/<entityId>/attachments/<attachmentId>
Add an attachment to a notePOSTGroup Notes:
/api/notes/groups/<groupid>/<entityId>/attachments
CREATE
Personal Note: 
/api/notes/me/<entityId>/attachments
Get an attachmentGETGroup Notes:
/api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId>
READ
Personal Note: 
/api/notes/me/<entityId>/attachments/<attachmentId>
Delete an attachmentDELETEGroup Notes:
/api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId>
DELETE
Personal Note: 
/api/notes/me/<entityId>/attachments/<attachmentId>
Delete a NoteDELETEGroup Notes:
https://mail.zoho.com/api/notes/groups/<groupid>/<entityId>
DELETE
Personal Note: 
https://mail.zoho.com/api/notes/me/<entityId>
Get all BooksGETGroup Notes:
/api/notes/groups/<groupid>/books
READ
Personal Note: 
/api/notes/me/books
Create a new BookPOSTGroup Notes:
/api/notes/groups/<groupid>/books
CREATE
Personal Note: 
/api/notes/me/books
Edit a BookPUTGroup Notes:
/api/notes/groups/<groupid>/books/<bookId>
UPDATE
Personal Note: 
/api/notes/me/books/<bookId>
Delete a BookDELETEGroup Notes:
/api/notes/groups/<groupid>/books/<bookId>
DELETE
Personal Note: 
/api/notes/me/books/<bookId>
Get all Notes in a BookGETGroup Notes:
/api/notes/groups/<groupid>/books/<bookId>
READ
Personal Note: 
/api/notes/me/books/<bookId>
Mark a note as favouritePUTGroup Notes:
/api/notes/groups/<groupid>/<entityId>/favorite
UPDATE
Personal Note: 
/api/notes/me/<entityId>/favorite
Unmark a note a favoriteDELETEGroup Notes:
/api/notes/groups/<groupid>/<entityId>/favorite
DELETE
Personal Note: 
/api/notes/me/<entityId>/favorite