API Guide Index

Organization API

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

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

Mail Policy API

Method NameMethod TypeURLOAuth ScopeOperation
Create Org PolicyPOST/api/organization/{zoid}/policyZohoMail.organization.policyCREATE
Create Email RestrictionPOST/api/organization/{zoid}/policyCREATE
Create Account RestrictionPOST/api/organization/{zoid}/policyCREATE
Create Access RestrictionPOST/api/organization/{zoid}/policyCREATE
Create Forward RestrictionPOST/api/organization/{zoid}/policyCREATE
Get All PoliciesGET/api/organization/{zoid}/policyREAD
Get All Email RestrictionsGET/api/organization/{zoid}/policy/mailRestrictionREAD
Get All Account RestrictionsGET/api/organization/{zoid}/policy/accountRestrictionREAD
Get All Access RestrictionsGET/api/organization/{zoid}/policy/accessRestrictionREAD
Get All Forward RestrictionsGET/api/organization/{zoid}/policy/mailForwardPolicyREAD
Get Policy UsersGET/api/organization/{zoid}/policy/{policyId}/getUsersREAD
Get Policy GroupsGET/api/organization/{zoid}/policy/{policyId}/getGroupsREAD
Apply Policy to Users/GroupsPUT/api/organization/{zoid}/policy/{policyId}UPDATE
Assign Email Restriction to PolicyPUT/api/organization/{zoid}/policy/{policyId}UPDATE
Assign Account Restriction to PolicyPUT/api/organization/{zoid}/policy/{policyId}UPDATE
Assign Access Restriction to PolicyPUT/api/organization/{zoid}/policy/{policyId}UPDATE
Assign Forward Restriction to PolicyPUT/api/organization/{zoid}/policy/{policyId}UPDATE

Accounts API

Method NameMethod TypeURLOAuth ScopeOperation
Get All Accounts of a UserGET/api/accountsZohoMail.accountsREAD
Get a Specific Account DetailsGET/api/accounts/{accountId}ZohoMail.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 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
Update Display Name and 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
Resend Verification for 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
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
Remove 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
Create a New LabelPOST/api/accounts/{accountId}/labelsZohoMail.tagsCREATE
Get all Label DetailsGET/api/accounts/{accountId}/labelsREAD
Get a Specific Label DetailsGET/api/accounts/{accountId}/labels/{labelid}READ
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
Add a new group or personal taskPOSTGroup tasks:
/api/tasks/groups/{zgid}
ZohoMail.tasks

CREATE

 

Personal tasks:
/api/tasks/me
Add a new projectPOST/api/tasks/groups/{zgid}/projectsCREATE
Get all tasks in a group or all personal tasksGETGroup tasks:
/api/tasks/groups/{zgid}
READ
Personal tasks:
/api/tasks/me
Get all tasks assigned to youGET/api/tasksREAD
Get all tasks created by youGET/api/tasksREAD
Get a specific taskGETGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
READ
Personal tasks:
/api/tasks/me/{taskId}
Get all subtasks under a taskGETGroup tasks:
/api/tasks/groups/{zgid}/{taskId}/subtasks
READ
Personal tasks:
/api/tasks/me/{taskId}/subtasks
Get all projects in a groupGET/api/tasks/groups/{zgid}/projectsREAD
Get all tasks in a projectGET/api/tasks/groups/{zgid}/projects/{projectId}READ
Get all tasks in a project with given statusGET/api/tasks/groups/{zgid}/projects/{projectId}READ
Get all groupsGET/api/tasks/groupsREAD
Get all tasks in a group with given statusGET/api/tasks/groups/{zgid}READ
Get member details in a groupGET/api/tasks/groups/{zgid}/membersREAD
Change task titlePUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Change task descriptionPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Change task priorityPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Change task statusPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Change task projectPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
/api/tasks/me/{taskId}
Change task assigneePUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Set/ change task due datePUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Set/ change task reminderPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Set/ change task reminder based on due datePUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
 /api/tasks/me/{taskId}
Set/ change recurring taskPUTGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
UPDATE
Personal tasks:
/api/tasks/me/{taskId}
Edit a projectPUT/api/tasks/groups/{zgid}/projects/{projectId}UPDATE
Delete a projectDELETE/api/tasks/groups/{zgid}/projects/{projectId}DELETE
Delete a group/personal taskDELETEGroup tasks:
/api/tasks/groups/{zgid}/{taskId}
DELETE
Personal tasks:
/api/tasks/me/{taskId}

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

Logs API

Method NameMethod TypeURLOAuth ScopeOperation
Get login historyGET/api/organization/{zoid}/accounts/reports/loginHistoryZohoMail.organization.accountsGET
Get audit recordsGET/api/organization/{zoid}/activityZohoMail.organization.auditGET
Get SMTP logsGET/api/organization/{zoid}/smtplogsZohoMail.partner.organizationGET