Actions - Email Notifications

Email Notification is an automated action that sends automated emails to leads, contacts, or users when specific conditions in a Zoho CRM automation are met.

GET Email Notifications

Purpose

To retrieve the list of email notifications configured in your Zoho CRM organization.

Endpoints

GET /settings/automation/email_notifications
GET /settings/automation/email_notifications/{email_notification_ID}

Request Details

Request URL

To retrieve all email notifications:
{api-domain}/crm/{version}/settings/automation/email_notifications

To get a specific email notification:
{api-domain}/crm/{version}/settings/automation/email_notifications/{email_notification_ID}

Supported modules

Leads, Accounts, Contacts, Deals, Tasks, Meetings, Calls, Products, Quotes, Sales Orders, Purchase Orders, Invoices, Campaigns, Vendors, Price Books, Cases, Solutions, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.{operation_type}

Possible operation types

ALL - Full access to email notifications
READ - Get email notifications

Sample Request for fetching all email notifications

Copiedcurl "https://www.zohoapis.com/crm/v/settings/automation/email_notifications"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Parameters

The below parameters are applicable ONLY for the endpoint to retrieve all email notifications.

filters string, optional
This parameter allows you to filter the email notifications by name.
For example, to fetch all the email notifications for which name contains "Leads" pass the filters parameter as { "field": {"api_name": "name"},"comparator": "contains","value": "Leads"}
Note
- You must encode the value of the filters parameter before sending the request.
- You can have only one criterion for this parameter.
- The supported value for api_name is "name" only.
- The supported value for comparator is "contains" only.
feature_typestring,optional
To retrieve specific email notifications based on their feature type.
Possible values: workflow
related_modulestring,optional
To retrieve specific email notifications based on their related module.
per_pageinteger,optional
Specify how many records to return per page. The default and the maximum possible value is 200.
Possible values: Positive integer values only.
pageinteger,optional
To get the list of records from the respective pages. The default value is 1.
Possible values: Positive integer values only.
sort_orderstring,optional
To sort the available list of email notifications in either ascending or descending order, based on the value of "sort_by" parameter.
Possible values:
- desc - Displays email notifications in descending order. This is the default value.
- asc - Displays email notifications in ascending order.
sort_bystring,optional
To sort the records based on the field modified_time.

Response JSON

templateJSON object
Represents the name and ID of the email template.
reply_to_addressstring
Represents the email address which will be populated in the "To" address when the email recipient clicks on "Reply" for the email.
creation_timestring (ISO 8601)
Timestamp of the creation of the email notification action was created.
lock_statusJSON object
Represents whether the workflow associated with the email notification is locked
- lockedBoolean
  Boolean value that indicates the lock status
editableBoolean
Represents whether the email notification can be edited.
moduleJSON object
Represents the API name and ID of the module.
related_moduleJSON object
Represents the API name and ID of the related module of the email notification that triggers the work flow rule.
deletableBoolean
Represents whether the email notification can be deleted.
recipient_countBoolean
Represents the count of recipients.
sourcestring
Source of the email notification.
created_byobject
Details of the user who created the email notification.
feature_typestring
The feature associated with the email notification.
modified_timestring (ISO 8601)
Timestamp of the last modification.
associatedboolean
Indicates whether the email notification is associated with any active workflow or automation.
namestring
Name of the email notification.
idstring
Unique identifier for the email notification.
from_addressobject
The "from" address of the email notification.
- from_address.details.emailstring
  Email address from which the email will be sent.
- from_address.typestring
  Type of the address source (e.g., "email").
- modified_byobject
  Details of the user who modified the notification.
- bulk_emailBoolean
  Indicates whether the email notification will be sent a single mass email with all recipients displayed. This field is available only when a specific email notification is fetched
- recipientsJSON object
  Consists of the details of the recipients of the email notification. This field is available only when a specific email notification is fetched.

Sample Response when all email notifications are fetched

Copied{
    "email_notifications": [
        {
            "template": {
                "name": "LeadAlert",
                "id": "6660682000001292005"
            },
            "reply_to_address": {
                "resource": {
                    "id": "6660682000000501001"
                },
                "type": "user"
            },
            "created_time": "2025-07-06T16:15:58+05:30",
            "lock_status": {
                "locked": false
            },
            "editable": true,
            "module": {
                "api_name": "Leads",
                "id": "6660682000000002175"
            },
            "related_module": null,
            "deletable": true,
            "recipient_count": "1",
            "source": "crm",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "feature_type": "workflow",
            "modified_time": "2025-07-06T16:15:58+05:30",
            "associated": true,
            "name": "NewLeadAlert",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "id": "6660682000001435009",
            "from_address": {
                "resource": {
                    "id": "6660682000000501001"
                },
                "type": "user"
            }
        },
        {
            "template": {
                "name": "Big Deal Alert",
                "id": "6660682000000000079"
            },
            "reply_to_address": null,
            "created_time": "2025-02-26T14:35:51+05:30",
            "lock_status": {
                "locked": false
            },
            "editable": true,
            "module": {
                "api_name": "Deals",
                "id": "6660682000000002181"
            },
            "related_module": null,
            "deletable": true,
            "recipient_count": "1",
            "source": "crm",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "feature_type": "workflow",
            "modified_time": "2025-02-26T14:35:51+05:30",
            "associated": true,
            "name": "Big Deal Alert",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "id": "6660682000000000353",
            "from_address": {
                "details": {
                    "email": "notifications@zohocrm.com"
                },
                "type": "email"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}

Possible Errors

INVALID_REQUEST_METHODHTTP 400
Invalid HTTP method to access the API URL.
Resolution: Check the HTTP Method of the request.
INVALID_DATAHTTP 400
Feature type parameter is invalid.
Resolution: Give correct value for the parameter.
OAUTH_SCOPE_MISMATCHHTTP 401
You do not have the scope required to use this API.
Resolution: Use the correct scope and generate the grant and access tokens.
NO_PERMISSIONHTTP 403
Permission denied.
Resolution: This error occurs when the user doesn't have permission. Contact administrator to obtain manage workflow permission.
INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.
INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in Server.
Resolution: Contact support team at support@zohocrm.com.

Sample Request for fetching a specific email notification

Copiedcurl "https://www.zohoapis.com/crm/v/settings/automation/email_notifications/6660682000000000353"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response when a specific email notification is fetched

Copied{
    "email_notifications": [
        {
            "template": {
                "name": "Big Deal Alert",
                "id": "6660682000000000079"
            },
            "reply_to_address": null,
            "created_time": "2025-02-26T14:35:51+05:30",
            "lock_status": {
                "locked": false
            },
            "editable": true,
            "module": {
                "api_name": "Deals",
                "id": "6660682000000002181"
            },
            "related_module": null,
            "deletable": true,
            "source": "crm",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "feature_type": "workflow",
            "modified_time": "2025-02-26T14:35:51+05:30",
            "bulk_email": false,
            "recipients": {
                "to": [
                    {
                        "associated_to": null,
                        "resource": {
                            "name": "Patricia Boyle",
                            "id": "6660682000000501001"
                        },
                        "details": null,
                        "type": "user"
                    }
                ]
            },
            "associated": true,
            "name": "Big Deal Alert",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "6660682000000501001"
            },
            "id": "6660682000000000353",
            "from_address": {
                "details": {
                    "email": "notifications@zohocrm.com"
                },
                "type": "email"
            }
        }
    ]
}