API Guide Index
Organization API
Method Name | Method Type | URL | OAuth Scope | Operation |
Add Child Organization | POST | /api/organization/ | ZohoMail.partner.organization | CREATE |
Get Organization Details | GET | /api/organization/{zoid} | READ | |
Get Org Subscription Details | GET | /api/organization/{zoid}/storage | ZohoMail.organization.subscriptions | READ |
Get User Storage Details | GET | /api/organization/{zoid}/storage/{zuid} | READ | |
Update User Storage | PUT | /api/organization/{zoid}/storage/{zuid} | UPDATE | |
Update Org Spam Process Type | PUT | /api/organization/{zoid} | ZohoMail.partner.organization | UPDATE |
Get Org Spam Listing | GET | /api/organization/{zoid}/antispam/data | ZohoMail.organization.spam | READ |
Add Org Spam Listing | PUT | /api/organization/{zoid}/antispam/data | UPDATE | |
Remove Org Spam Listing | DELETE | /api/organization/{zoid}/antispam/data | DELETE | |
Add Allowed IPs | POST | /api/organization/{zoid}/allowedIps | ZohoMail.organization.accounts | CREATE |
Get Allowed IPs List | GET | /api/organization/{zoid}/allowedIps | READ | |
Delete Allowed IPs | DELETE | /api/organization/{zoid}/allowedIps | DELETE |
Domain API
Method Name | Method Type | URL | OAuth Scope | Operation |
All Domain Details | GET | /api/organization/<zoid>/domains | ZohoMail.organization.domains | READ |
Single Domain Details | GET | /api/organization/<zoid>/domains/<domainname> | READ | |
Add Domain to an Organization | POST | /api/organization/<zoid>/domains | CREATE | |
Verify a Domain in the Organization | PUT | /api /organization/<zoid>/domains | UPDATE | |
Make a Domain as Primary | PUT | /api/organization/<zoid>/domains | UPDATE | |
Enable Email Hosting for a Domain | PUT | /api/organization/<zoid>/domains | UPDATE | |
Disable Email Hosting for a Domain | PUT | /api/organization/<zoid>/domains | UPDATE | |
Make a Domain as an Alias Domain | PUT | /api/organization/<zoid>/domains | UPDATE | |
Remove a Domain from Domain Alias | PUT | /api/organization/<zoid>/domains | UPDATE | |
Delete a Domain from the Organization | DELETE | /api/organization/<zoid>/domains | DELETE |
Groups API
Method Name | Method Type | URL | OAuth Scope | Operation |
Create a group | POST | /api/organization/{zoid}/groups | ZohoMail.organization.groups | CREATE |
Get all group details | GET | /api/organization/{zoid}/groups | READ | |
Get specific group details | GET | /api/organization/{zoid}/groups/{zgid} | READ | |
Get all emails held for moderation | GET | /api/organization/{zoid}/groups/{zgid}/messages | READ | |
Get moderation email content | GET | /api/organization/{zoid}/groups/{zgid}/messages/{messageId} | READ | |
Moderate emails in a group | PUT | /api/organization/{zoid}/groups/{zgid}/messages | UPDATE | |
Update group name | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Enable streams for a group | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Add group members | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Delete group members | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Update member status | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Update member role | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Update member settings | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Update threshold limit | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Update advanced admin settings | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Add group email alias | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Remove group email alias | PUT | /api/organization/{zoid}/groups/{zgid} | UPDATE | |
Delete group | DELETE | /api/organization/{zoid}/groups/{zgid} or /api/organization/{zoid}/groups | DELETE |
Users API
Method Name | Method Type | URL | OAuth Scope | Operation |
All Users Mail Account Details | GET | /api/organization/<zoid>/accounts/ | ZohoMail.organization.accounts | READ |
Single User Details | GET | /api/organization/<zoid>/accounts/<accountid> | READ | |
Add User Account to an Organization | POST | /api/organization/<zoid>/accounts/ | CREATE | |
Change the role of a User | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
Reset the password of a User | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
Add an email Alias to the User Account | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
Delete an email Alias from the User Account | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
To enable the User's Mail Account | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
To disable the User's Mail Account | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
To change Incoming Status | PUT | /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
To change Outgoing Status | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
To change IMAP Status | PUT | Admin Authentication: /api/organization/<zoid>/accounts/ | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
To change POP Status | PUT | Admin Authentication: /api/organization/<zoid>/accounts/ | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
To change ActiveSync Status | PUT | /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
To change TFA Preference | PUT | /api/organization/<zoid>/accounts/<accountid> | UPDATE | |
To Enable User | PUT | /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
To Disable User | PUT | /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
Accounts API
Method Name | Method Type | URL | OAuth Scope | Operation |
User Account Details | GET | /api/accounts | ZohoMail.accounts | READ |
Update Mail Account Sequence | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Reply To Address | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Resend Verification for Reply To Address | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Add Send Mail Details | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Send Mail Address | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Display Name and Email Address | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Display Name | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Email Address | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Add Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Verify Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Enable Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Resend Verification for Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Disable Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Delete Zoho Mail copy in Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Delete Email Forwarding | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Add Vacation Reply | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Update Vacation Reply | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts | |||
Remove Vacation Reply | PUT | Admin Authentication: /api/organization/<zoid>/accounts/<accountid> | ZohoMail.organization.accounts | UPDATE |
User Authentication: /api/accounts/<accountid> | ZohoMail.accounts |
Folders API
Method Name | Method Type | URL | OAuth Scope | Operation |
Create a new folder | POST | /api/accounts/{accountId}/folders | ZohoMail.folders | CREATE |
Get all Folders | GET | /api/accounts/{accountId}/folders | READ | |
Get specific folder | GET | /api/accounts/{accountId}/folders/{folderId} | READ | |
Rename folder | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Move folder | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Enable IMAP view for folder | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Disable IMAP view for folder | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Mark folder as read | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Empty folder | PUT | /api/accounts/{accountId}/folders/{folderId} | UPDATE | |
Delete folder | DELETE | /api/accounts/{accountId}/folders/{folderId} | DELETE |
Label API
Method Name | Method Type | URL | OAuth Scope | Operation |
Get all Label Details | GET | /api/accounts/<accountId>/labels | ZohoMail.tags | READ |
Get Details of a Single Label | GET | /api/accounts/<accountId>/labels/<labelid> | READ | |
Create a new Label | POST | /api/accounts/<accountId>/labels | CREATE | |
Update a Label | PUT | /api/accounts/<accountId>/labels/<labelid> | UPDATE | |
Delete a Label | DELETE | /api/accounts/<accountId>/labels/<labelid> | DELETE |
Email Messages API
Method Name | Method Type | URL | OAuth Scope | Operation |
List of emails in a folder | GET | /api/accounts/<accountId>/messages/view | ZohoMail.messages | READ |
List search results | GET | /api/accounts/<accountId>/messages/search | READ | |
Get meta data of an email | GET | /api/accounts/<accountId>/folders/folderid/messages/<messageId>/details | READ | |
Get attachment info | GET | /api/accounts/<accountId>/folders/folderId/messages/<messageId>/attachmentinfo | READ | |
Get email content | GET | /api/accounts/<accountId>/folders/folderId/messages/<messageId>/content | READ | |
Get email headers | GET | /api/accounts/<accountId>/folders/folderId/messages/<messageId>/header | READ | |
Mark emails as read | PUT | /api/accounts/<accountId>/updatemessage | UPDATE | |
Send an email | POST | /api/accounts/<accountId>/messages | CREATE | |
Send an email with attachment | POST | /api/accounts/<accountId>/messages | CREATE |
Signatures API
Method Name | Method Type | URL | OAuth Scope | Operation |
Add user signature | POST | /api/accounts/signature | ZohoMail.accounts | CREATE |
Get user signature | GET | /api/accounts/signature | READ | |
Update user signature | PUT | /api/accounts/signature | UPDATE | |
Delete user signature | DELETE | /api/accounts/signature | DELETE |
Threads API
Method Name | Method Type | URL | OAuth Scope | Operation |
Flag thread | PUT | /api/accounts/{accountId}/updatethread | ZohoMail.messages | UPDATE |
Move thread | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Apply Label to thread | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Remove label from thread | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Remove all labels from thread | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Mark thread as read | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Mark thread as unread | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Mark thread as spam | PUT | /api/accounts/{accountId}/updatethread | UPDATE | |
Mark thread as not spam | PUT | /api/accounts/{accountId}/updatethread | UPDATE |
Tasks API
Method Name | Method Type | URL | OAuth Scope | Operation |
Get all Tasks in a Group | GET | /api/tasks/groups/<GroupID> | ZohoMail.tasks | READ |
Get personal Tasks | GET | /api/tasks/me | READ | |
Get all Tasks asigned to you | GET | /api/tasks?view=assignedtome&action=view | READ | |
Get all Tasks created by you | GET | /api/tasks?view=createdbyme&action=view | READ | |
Get single Task | GET | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | READ | |
Personal Tasks: /api/tasks/me/<entityId> | ||||
Get all subtasks | GET | Group Tasks: /api/tasks/groups/<GroupID>/<entityId>/subtasks | READ | |
Personal Tasks: /api/tasks/me/<entityId>/subtasks | ||||
Get all Tasks in a specific project | GET | /api/tasks/groups/<GroupID>/projects/<projectId> | READ | |
Get all Tasks with given status | GET | /api/tasks/groups/<GroupID>/?status=<Status> | READ | |
Add a new group Task | POST | /api/tasks/groups/<GroupID> | CREATE | |
Add a new personal Task | POST | /api/tasks/me | CREATE | |
Change Task title | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change Task description | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change Task priority | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change Task status | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change Task project | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change Task assignee | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Set/ change Task due date | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Set/ change Task Reminder | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Set/ change Task reminder based on Due Date | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId> | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId | ||||
Change or set recurring Task | PUT | Group Tasks: /api/tasks/groups/<GroupID>/<entityId>? | UPDATE | |
Personal Tasks: /api/tasks/me/<entityId>? | ||||
Delete a group Task | DELETE | /api/tasks/groups/<GroupID>/<entityId> | DELETE | |
Delete a Task assigned to you/ created by you | DELETE | /api/tasks/<entityId> | DELETE | |
Get all projects in a group | GET | /api/tasks/groups/<groupId>/projects | READ | |
Get all Tasks in a project with a given status | GET | /api/tasks/groups/<GroupID>/projects/<projectId>?status=<Status> | READ | |
Add a new project | POST | /api/tasks/groups/<groupId>/projects? | CREATE | |
Edit a project | PUT | /api/tasks/groups/<groupId>/projects/<projectId> | UPDATE | |
Delete a project | DELETE | /api/tasks/groups/<groupId>/projects/<projectId> | DELETE | |
Get all groups | GET | /api/tasks/groups | READ | |
Get member details in a group | GET | /api/tasks/groups/<GroupId>/members | READ |
Bookmarks API
Method Name | Method Type | URL | OAuth Scope | Operation |
Get all Groups | GET | /api/links/groups | ZohoMail.links | READ |
Get all Bookmarks | GET | Group Bookmarks: /api/links/groups/<groupid> | READ | |
Personal Bookmarks: /api/links/me | ||||
Add a new Bookmark | POST | Group Bookmarks: /api/links/groups/<groupid> | CREATE | |
Personal Bookmarks: /api/links/me | ||||
Get a Bookmark | GET | Group Bookmarks: /api/links/groups/<groupid>/<entityId> | READ | |
Personal Bookmarks: /api/links/me/<entityId> | ||||
Edit a Bookmark | PUT | Group Bookmarks: /api/links/groups/<groupid>/<entityId> | UPDATE | |
Personal Bookmarks: /api/links/me/<entityId> | ||||
Mark a Bookmark as favorite | PUT | Group Bookmarks: /api/links/groups/<groupid>/<entityId>/favorite | UPDATE | |
Personal Bookmarks: /api/links/me/<entityId>/favorite | ||||
Unmark a Bookmark as favorites | DELETE | Group Bookmarks: /api/links/groups/<groupid>/<entityId>/favorite | DELETE | |
Personal Bookmarks: /api/links/me/<entityId>/favorite | ||||
Delete a Bookmark | DELETE | Group Bookmarks: /api/links/groups/<groupid>/<entityId> | DELETE | |
Personal Bookmarks: /api/links/me/<entityId> | ||||
Get all collections | GET | Group Bookmarks: /api/links/groups/<groupid>/collections | READ | |
Personal Bookmarks: /api/links/me/collections | ||||
Create a collection | POST | Group Bookmarks: /api/links/groups/<groupid>/collections | CREATE | |
Personal Bookmarks: /api/links/me/collections | ||||
Edit a collection | PUT | Group Bookmarks: /api/links/groups/<groupid>/collections/<collectionId> | UPDATE | |
Personal Bookmarks: /api/links/me/collections/<collectionId> | ||||
Delete a collection | DELETE | Group Bookmarks: /api/links/groups/<groupid>/collections/<collectionId> | DELETE | |
Personal Bookmarks: /api/links/me/collections/<collectionId> | ||||
Get all Bookmarks in a collection | GET | Group Bookmarks: /api/links/groups/<groupid>/collections/<collectionId> | READ | |
Personal Bookmarks: /api/links/me/collections/<collectionId> |
Notes API
Method Name | Method Type | URL | OAuth Scope | Operation |
Get all groups | GET | /api/notes/groups | ZohoMail.notes | READ |
Get all Notes | GET | Group Notes: /api/notes/groups/<groupid> | READ | |
Personal Notes: /api/notes/me | ||||
Create a Note | POST | Group Notes: /api/notes/groups/<groupid> | CREATE | |
Personal Note: /api/notes/me | ||||
Get a Note | GET | Group Notes: /api/notes/groups/<groupid>/<entityId> | READ | |
Personal Note: /api/notes/me/<entityId> | ||||
Edit a note | PUT | Group Notes: /api/notes/groups/<groupid>/<entityId> | UPDATE | |
Personal Note: /api/notes/me/<entityId> | ||||
Get attachments in a note | GET | Group Notes: /api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId> | READ | |
Personal Note: /api/notes/me/<entityId>/attachments/<attachmentId> | ||||
Add an attachment to a note | POST | Group Notes: /api/notes/groups/<groupid>/<entityId>/attachments | CREATE | |
Personal Note: /api/notes/me/<entityId>/attachments | ||||
Get an attachment | GET | Group Notes: /api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId> | READ | |
Personal Note: /api/notes/me/<entityId>/attachments/<attachmentId> | ||||
Delete an attachment | DELETE | Group Notes: /api/notes/groups/<groupid>/<entityId>/attachments/<attachmentId> | DELETE | |
Personal Note: /api/notes/me/<entityId>/attachments/<attachmentId> | ||||
Delete a Note | DELETE | Group Notes: https://mail.zoho.com/api/notes/groups/<groupid>/<entityId> | DELETE | |
Personal Note: https://mail.zoho.com/api/notes/me/<entityId> | ||||
Get all Books | GET | Group Notes: /api/notes/groups/<groupid>/books | READ | |
Personal Note: /api/notes/me/books | ||||
Create a new Book | POST | Group Notes: /api/notes/groups/<groupid>/books | CREATE | |
Personal Note: /api/notes/me/books | ||||
Edit a Book | PUT | Group Notes: /api/notes/groups/<groupid>/books/<bookId> | UPDATE | |
Personal Note: /api/notes/me/books/<bookId> | ||||
Delete a Book | DELETE | Group Notes: /api/notes/groups/<groupid>/books/<bookId> | DELETE | |
Personal Note: /api/notes/me/books/<bookId> | ||||
Get all Notes in a Book | GET | Group Notes: /api/notes/groups/<groupid>/books/<bookId> | READ | |
Personal Note: /api/notes/me/books/<bookId> | ||||
Mark a note as favourite | PUT | Group Notes: /api/notes/groups/<groupid>/<entityId>/favorite | UPDATE | |
Personal Note: /api/notes/me/<entityId>/favorite | ||||
Unmark a note a favorite | DELETE | Group Notes: /api/notes/groups/<groupid>/<entityId>/favorite | DELETE | |
Personal Note: /api/notes/me/<entityId>/favorite |