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

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
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

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

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

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

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

CommunitySpaces
 
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
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

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

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

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

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

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

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

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

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

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

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

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

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
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
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

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

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

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

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

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

Embedded BI
 
DataPrep

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

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

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
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

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

QEngine
 
Tables

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

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

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

Embedded BI
 
NEW
IoT

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

IoT
 
DataPrep

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

DataPrep

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
 
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 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
Marketplace
Skip to main content

Send Mail

Purpose

To send emails through an API.

Request Details

Request URL

All - {api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/send_mail

Supported modules

Leads, Contacts, Deals, Accounts, Sales Orders, Purchase Orders, Invoices, Quotes, Cases, and Custom.

Header

Authorization: Zoho-oauthtoken <access_token>

Scope

scope=ZohoCRM.send_mail.{module_name}.CREATE
(or) scope=ZohoCRM.send_mail.all.CREATE

Possible Module Names

leads, accounts, contacts, deals, quotes, salesorders, purchaseorders, invoices, cases, and custom

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v3/Leads/3652397000002181001/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
Request JSON
  • fromJSON object, mandatory

    The user name and email address from which you want to send an email.

  • toJSON array, mandatory

    The user name and email address to which you want to send an email. Include multiple JSON objects if you want to email multiple users.

  • ccJSON array, optional

    The user name and email address that you want to cc when you send an email. Include multiple JSON objects if you want to cc multiple users.

  • bccJSON array, optional

    The user name and email address that you want to bcc when you send an email. Include multiple JSON objects if you want to bcc multiple users.

  • reply_toJSON object, optional

    The user name and email address that you want the user to reply to after receiving the mail.

  • org_emailBoolean, optional

    The value true represents that the mail is sent from the organization's email address. Note that when you set this value to true, the mail is sent through Zoho CRM's server and not through the SMTP server that you have configured. The default value is false.

  • in_reply_toString, optional

    Input this key only when you reply to an email. This key takes the previous mail's (the mail that you sent earlier) message_ID. Note that when your mailbox is synced via IMAP or POP integration, all mail replies will form the 'Thread View' by default.

  • scheduled_timeDateTime in ISO8601 format, optional

    Input this key only when you want to schedule an email. The date and time must be in the ISO8601 format.

  • subjectString, optional

    The subject of the email.

  • mail_formatString, optional

    The format of the email such as plain text or rich text. The value html indicates the rich text format and text indicates the plain text format.

  • contentString, optional

    The encrypted ID obtained when you uploaded a file to ZFS using the Files API. Include multiple JSON objects if you want to attach multiple files.

  • templateJSON object, optional

    The unique ID of the template from which the subject, content, and attachments will be included in the email. If you specify the template ID, and include the keys "subject", "content", "attachments", the values in these keys will only be considered.

Sample Input

Copied{
    "data": [
        {
            "from": {
                "user_name": "Patricia Boyle",
                "email": "p.boyle@zoho.com"
            },
            "to": [
                {
                    "user_name": "Jason Smith",
                    "email": "j.smith@zoho.com"
                }
            ],
            "cc": [
                {
                    "user_name": "user3",
                    "email": "user3email@zoho.com"
                }
            ],
            "bcc": [
                {
                    "user_name": "user4",
                    "email": "user4email@zoho.com"
                }
            ],
            "reply_to": {
                "user_name": "user5",
                "email": "user5email@zoho.com"
            },
            "org_email": false,
            "in_reply_to": "2cceafa194d037b63f2000181dd8186486f1eb0360aee76d802b6d376dea97e7",
            "scheduled_time": "2021-06-12T12:12:12+05:30",
            "subject": "Testing Send Mail API",
            "content": "<h3><span style=\"background-color: rgb(254, 255, 102)\">Mail is of rich text format</span></h3><h3><span style=\"background-color: rgb(254, 255, 102)\"><img src=\"https://www.zohoapis.com/crm/viewInLineImage?fileContent=2cceafa194d037b63f2000181dd818646fd5e5167a274098b625c35654a20ed2\"></span></h3><h3><span style=\"background-color: rgb(254, 255, 102)\">REGARDS,</span></h3><div><span style=\"background-color: rgb(254, 255, 102)\">AZ</span></div><div><span style=\"background-color: rgb(254, 255, 102)\">ADMIN</span></div> <div></div>",
            "mail_format": "html",
            "attachments": [
                {
                    "id": "2cceafa194d037b63f2000181dd81864b4812b1f8b0b4fe0949a982de89fa75a"
                }
            ],
            "template": {
                "id": "3652397000002497001"
            }
        }
    ]
}

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "message_id": "2cceafa194d037b63f2000181dd8186486f1eb0360aee76d802b6d376dea22e2"
            },
            "message": "Your mail has been scheduled successfully.",
            "status": "success"
        }
    ]
}
Request JSON to send an email to the inventory modules

For inventory modules (Quotes, Sales Orders, Purchase Orders, Invoices), the inventory templates will be sent as email attachments.

  • inventory_detailsJSON object, mandatory 

    Represents the details of the inventory template such as the template ID, paper type, and the view type.

  • inventory_templateJSON object, mandatory 

    The unique ID of the inventory template you want to use in your email, and the name of the template.

  • paper_typeString, optional

    The paper type for digital printing. The possible values are default, A4, and us_letter. The default value is A4.

  • view_typeString, optional

    The way you want to view the template in. The possible values are portrait and landscape. The default value is portrait.

Sample request to send an email from the inventory module

Copiedcurl "https://www.zohoapis.com/crm/v3/Purchase_Orders/3652397000000491180/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"

Sample Input

Copied{
    "data": [
        {
            "from": {
                "user_name": "Patricia Boyle",
                "email": "p.boyle@abc.com"
            },
            "to": [
                {
                    "user_name": "user1",
                    "email": "user1@gmail.com"
                }
            ],
            "inventory_details": {
                "inventory_template": {
                    "id": "3652397000000187009",
                    "name": "CT Scan Machines.pdf"
                },
                "paper_type": "A4",
                "view_type": "portrait"
            }
        }
    ]
}

Show full

Show less

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "message_id": "2cceafa194d037b63f2000181dd8186468a4f140fd300509994fb12dd4c97e67"
            },
            "message": "Your mail has been sent successfully.",
            "status": "success"
        }
    ]
}
Request JSON for GDPR-related data

Use the following keys when you have enabled GDPR compliance settings, and want to send an email asking for the user's consent or request data. Note that it is mandatory to send the consent form in the email's "content" key, when you ask for the lead's/contact's consent.

  • consent_emailBoolean, mandatory when you want to ask for the receiver's consent

    The value true indicates that the mail is a consent mail. The default value is false.

  • data_subject_requestJSON object, optional

    The unique ID of the data subject request and the "type".
    The "type" key takes one of the following values.

    • access - Represents that the Data Subject can view their personal data on sending an email with information about personal fields.
    • rectify - Represents that the Data Subject can rectify personal fields by sending a .CSV file containing personal information and updating changes manually.
    • export - Represents that the Data Subject will have a copy of their personal data in .CSV format, which can be used in other systems.

Note

  • Emails are associated to record based on Entity ID and not by email addresses in to/cc/bcc.
  • You can only send emails from one of the allowed "from" addresses.
  • For details about the edition-wise limits on the number of emails you can send, refer to Email Limits.
  • The format of including an inline image in the "content" key is <img src="https://<base-url>/crm/viewInLineImage?fileContent={file id from upload inline images api}\>
  • You must enable compliance settings and data processing for the records before you can send them the consent form in an email.

Sample request to send GDPR-related data

Copiedcurl "https://www.zohoapis.com/crm/v3/Leads/3652397000002181001/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"

Sample Input

Copied{
    "data": [
        {
            "from": {
                "user_name": "Patricia Boyle",
                "email": "p.boyle@abc.com"
            },
            "to": [
                {
                    "user_name": "user1",
                    "email": "user1email@zoho.com"
                }
            ],
            "subject": "Mail subject",
            "content": "<br><a href=\"${ConsentForm.en_US}\" id=\"ConsentForm\" class=\"en_US\" target=\"_blank\">Consent form link</a><br><br><br><br><br><h3><span style=\"background-color: rgb(254, 255, 102)\">REGARDS,</span></h3><div><span style=\"background-color: rgb(254, 255, 102)\">AZ</span></div><div><span style=\"background-color: rgb(254, 255, 102)\">ADMIN</span></div> <div></div>",
            "consent_email": true,
            "mail_format": "html",
            "data_subject_request": {
                "id": "482134000000568909",
                "type": "access"
            }
        }
    ]
}

Possible Errors

  • MANDATORY_NOT_FOUNDHTTP 400

    Either the sender's or the recipient's email address is missing in the input.
    Resolution: Use the "parent_api_name" key for the missing details in the input. For sender's email address, get the list of allowed "from" addresses through this API.

  • LIMIT_EXCEEDEDHTTP 400

    You have exceeded the maximum email limit for the day. Please refer this document to know the email limits for different CRM editions.
    Resolution: Send emails the next day. To increase the mass email limit at an additional cost, contact support@zohocrm.com.

  • NOT_ALLOWEDHTTP 400

    This feature is not supported for your edition.
    Resolution: Contact your administrator.

  • NOT_ALLOWEDHTTP 400

    The intended receiver has not consented to receive your email.
    Resolution: Per GDPR compliance, every lead/contact must grant their consent to receive emails. Send them the consent form and obtain their consent to send emails.

  • NOT_ALLOWEDHTTP 400

    The intended receiver has opted to stop email communication.
    Resolution: Per GDPR compliance, every lead/contact must grant their consent to receive emails. Send them the consent form and obtain their consent to send emails.

  • NOT_ALLOWEDHTTP 400

    The record does not have either primary or secondary email addresses.
    Resolution: The associated contact does not have an email address in the Deals module. Add either a primary, secondary, or custom email address in the Deals module to send emails.

  • NOT_ALLOWEDHTTP 400

    Emails from either the record's email address or the recipient's email address have bounced and thus, blocked.
    Resolution: Refer to the "details" key in the response to know which email address is blocked. Contact support@zohocrm.com.

  • INVALID_DATAHTTP 400

    The record ID in the request is invalid.
    Resolution: Provide a valid record ID.

  • INVALID_DATAHTTP 400

    You cannot use this email address to send mails from.
    Resolution: You can send emails only from the list of allowed "from" addresses.

  • INVALID_DATAHTTP 400

    Compliance settings are not enabled for the record.
    Resolution: You must enable compliance settings and data processing for the record before you can send emails with the consent form.

  • INVALID_DATAHTTP 400

    You have provided an incorrect encrypted ID for the attachment.
    Resolution: Refer to the "details" key to know which key has the incorrect input.

  • FILE_SIZE_EXCEEDSHTTP 400

    The total size of the attachment has exceeded 10 MB.
    Resolution: You can include multiple attachment in the email but the size of the attachments,in total, must not exceed 10 MB.

  • CUSTOM_ERRORHTTP 400

    An error occurred while connecting to the SMTP server.
    Resolution: Ensure that you give proper credentials in email configuration or login again.

  • FEATURE_NOT_SUPPORTEDHTTP 400

    Your edition does not support sending scheduled emails.
    Resolution: This feature is not available in the trial and free editions. Please contact your administrator.

  • RECORD_LOCKEDHTTP 400

    You cannot perform this operation as the record is locked.
    Resolution: Please wait until the record is unlocked.

  • NO_PERMISSIONHTTP 403

    You have enabled "Email Opt Out" for that record.
    Resolution: Disable "Email Opt Out" to send emails.

  • NO_PERMISSIONHTTP 403

    You have not confirmed your account.
    Resolution: Confirm the registered account to send emails.

  • NO_PERMISSIONHTTP 403

    You have not confirmed your email associated to your account.
    Resolution: Confirm the registered email.