Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Zoho Mail REST APIs Getting Started

Prerequisites

  1. You need a valid Zoho Mail account to use the API. Sign up or Login to Zoho Mail to access the services.
  2. Ensure you have the necessary permissions from your system administrator to access and use the API services.
  3. Generate a valid OAuth token to authenticate your API requests. Refer to Zoho's OAuth Token Guide for instructions.
  4. Confirm that your user account has the appropriate role to access the required API endpoints.
  5. Host your application on a custom-maintained server that can handle API requests and responses.
  6. Ensure a stable internet connection to send API requests and receive responses from Zoho Mail's servers.
     

Multiple Data Centers

Zoho Mail is hosted in multiple data centers across various regions, each associated with a different domain. There are seven distinct domains for Zoho Mail APIs, and you need to use the domain that corresponds to your data center.

Data CenterDomainBase API URI
United States.comhttps://www.mail.zoho.com
Europe.ukhttps://www.mail.zoho.uk
India.inhttps://www.mail.zoho.in
Australia.com.auhttps://www.mail.zoho.com.au
Japan.jphttps://www.mail.zoho.jp
Canada.cahttps://www.mail.zoho.ca
Saudi Arabia.sahttps://www.mail.zoho.sa

The APIs referenced on this page are for organizations hosted on the .com domain. If your organization uses a different domain, you must replace .com with the appropriate domain in the API endpoints before using them.

Note:

To identify the domain you're accessing Zoho Mail from, check the URL of your Zoho Mail web app. If the URL contains "mail.zoho.com", you are using the .com domain. If it contains "mail.zoho.in", you're using the .in domain. Other regional domains like .uk, .com.au, .jp, or .ca may also be in use based on your data center.
For example : To modify the domain in a Zoho Mail API endpoint for the .eu domain: 
Original API endpoint for the .com domain:    https://www.mail.zoho.com/api/accounts 
Modified API endpoint for the .eu domain:    https://www.mail.zoho.eu/api/accounts

HTTP Methods

Zoho Mail is hosted in multiple data centers, making it available on different domains. There are seven different domains for Zoho Mail's APIs, and you will have to use the one that applies to you.

MethodDescription
POSTUsed for creating resources and performing resource actions.
GETUsed for retrieving resources.
PUTUsed for updating resources.
DELETEUsed for deleting resources.

Common Terminologies Used

  • Zoho Organization ID (zoid)

    Description: The Zoho Organization ID is a unique identifier assigned to each organization. You need this ID for making API requests related to domain and organization.
    How to Retrieve: You can fetch the zoid by using the Get Organization Details API.

  • Zoho User ID (zuid)

    Description: The Zoho User ID is a unique identifier specific to each user. You need this ID when making user-specific API calls.
    How to Retrieve (User): Users can find their zuid by clicking their avatar at the top right corner of their Zoho Mail interface. The User ID displayed in the popup as Zoho User ID is the zuid.
    How to Retrieve (Admin): If you are an Admin and want to retrieve the zuid for all users in your organization, use the Fetch Organization User Details API.

  • Account ID (accountId)

    Description: The Account ID is a unique identifier assigned to each account within Zoho Mail. Users may have multiple accounts, including external POP accounts, each with a distinct Account ID.
    How to Retrieve: You can retrieve a user's Account ID using the Fetch a Specific User Details API (requires zuid) or get Account IDs for all users using the Fetch all Org User Details API (requires zoid).

  • Group ID (zgid)

    Description: A group is an email distribution list that allows multiple users to share a common email address for team or departmental communication. Group members receive and manage emails collectively, enhancing collaboration. The Group ID is the unique identifier assigned to each group within an organization.
    How to Retrieve: You can retrieve the Group ID of all the groups in your organization by using the Get All Groups Details API.

  • Folder ID (folderId)

    Description: Each folder in your Zoho Mail account has a unique folder ID. This includes folders in any POP accounts you may have added, each of which will also have a distinct ID. 
    How to Retrieve: Use the Get All Folder Details API to fetch the Folder ID for all folders in your account.

  • Label ID (labelId)

    Description: Labels in Zoho Mail allow users to categorize emails. Each label has a unique Label ID.
    How to Retrieve: You can obtain the Label ID using the Get All Label Details API.

  • Message ID (messageId)

    Description: Your Zoho Mail account assigns a unique Message ID to every email. This ID is essential for message-specific API requests, such as marking an email as read or retrieving email headers.
    How to Retrieve: To fetch the Message ID of emails, use the List of Emails in a Folder API for a specific folder or the List Emails Based on Search Parameters API for emails matching specific search criteria.

  • Thread ID (threadId)

    Description: A thread represents a series of related email messages grouped together based on the conversation. This includes all replies and forwards related to the original message. A Thread ID is a unique identifier assigned to each thread. The thread ID is used to reference and manage the entire conversation within the thread.
    How to Retrieve: The List of Emails in a Folder API provides messages with their Thread IDs, while the List Emails Based on Search Parameters API returns messages matching specific search criteria along with their Thread IDs.

  • Task ID (taskId)

    Description: Tasks represent actionable items, such as to-do lists of the user. A Task ID is a unique identifier assigned to each task in Zoho Mail. 
    How to Retrieve: You can obtain the Task ID using the Get All Tasks in a Group/Personal Tasks API.

  • Bookmark ID (bookmarkId)

    Description: Bookmarks in Zoho Mail allow users to save and organize web links. A Bookmark ID is a unique identifier for each bookmark.
    How to Retrieve: You can obtain the Bookmark ID using the Get All Bookmarks API.

  • Note ID (noteId)

    Description: Notes in Zoho Mail are user-created text entries for storing information. A Note ID is a unique identifier for each note.
    How to Retrieve: You can obtain the Note ID using the Get All Notes API.

Making the First API Request : Sending an Email via Zoho Mail API

Below is a step-by-step guide to making your first API request using Zoho Mail's REST API to send an email.

Step 1: Get OAuth Token

Before making the API call, you need an OAuth token to authenticate your requests. Follow Zoho Mail's OAuth Token Guide to generate one.

Step 2: HTTP Method and API Endpoint

HTTP Method : POST
API Endpoint : https://mail.zoho.com/api/accounts/{accountId}/messages

Step 3: Sample CURL Request

curl "https://mail.zoho.com/api/accounts/123456789/messages" \
-X POST \ -H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *********" \ 
-d '{ "fromAddress": "rebecca@zylker.com",
"toAddress": "paula@zylker.com",
"subject": "Invitation",
"content": "Invitation content"
}'

Note : Make sure to replace {accountId} with your account ID and *********** with your Zoho OAuth token.

Step 5: Sample JSON Response

Successful Response: 

{
"status": {
"code": 200,
"description": "success"
},
"data": {
"subject": "Invitation",
"messageId": "1726208416259127700",
"fromAddress": "rebecca@zylker.com",
"mailId": "<191ea0a1955.d9bc1acf2142936.8470410454014158620@zylker.com>",
"toAddress": "paula@zylker.com",
"content": "Invitation content"
}
}

Unsuccessful Response:

{
"status": {
"code": 500,
"description": "Internal Error"
},
"data": {
"moreInfo": "Internal Error"
}
}

For more details, refer Response Codes in Zoho Mail.

Error Handling

Error handling in Zoho Mail's REST APIs ensures consistent responses when errors occur. Below are key aspects:

HTTP Status Codes

Zoho Mail API uses standard HTTP status codes to indicate the success or failure of a request. 

Example status code and description:

"status": {
"code": 500,
"description": "Internal Error"
}

Error Messages

In addition to HTTP status codes, Zoho Mail API returns a JSON response with details about the error. The typical error response format includes:

Example error response:

"data": {
   "moreInfo": "The input passed is invalid"
}

Rate Limiting

Each Zoho Mail's REST API has its own rate limit, which may vary depending on the specific API. If you exceed the API usage limit, the response will notify you.

By following this guide, you can successfully send your first email via Zoho Mail’s REST API.