Zoho: Get an Email Notification by ID
Zoho emailNotifications.getEmailNotificationsById: arguments, response, policy and SDK examples.
← Email notifications operations · Get started
Operation zoho.getemailnotificationsbyid
Provider route: GET /crm/v8/settings/automation/email_notifications/{id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["emailNotifications"]["getEmailNotificationsById"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.emailNotifications.getEmailNotificationsById(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.email_notifications.get_email_notifications_by_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | Maximum length: 20 |
query | object | Optional | Additional keys: not allowed |
query.include_inner_details | string | Optional | One of: module.plural_label, related_module.plural_label, from_address.field_label |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get an Email Notification by ID — response body |
Referenced models: Get an Email Notification by ID — response body
Schemas
Section titled “Schemas”28 more schemas are linked from the tables above, on the schema pages.
Get an Email Notification by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response object returned when a specific email notification definition is retrieved by its ID, containing the full configuration details of the matched notification. Additional keys: not allowed |
email_notifications | array | Optional | Represents the list of email notification definitions returned for the specified ID. Contains at most one email notification object with the full configuration details, including template, recipient, and sender settings. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Get an Email Notification by ID — response body — email notifications item |
Referenced models: Get an Email Notification by ID — response body — email notifications item
Get an Email Notification by ID — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a complete email notification action definition in Zoho CRM, including its configuration fields, email template, recipient details, sender and reply-to address settings, and server-managed metadata such as creation and modification timestamps. Additional keys: not allowed |
associated | boolean | Optional | Indicates whether this email notification action is currently associated with any automation rule or process. Possible values: true - The action is linked to one or more automation rules or processes. false - The action is not linked to any automation rule or process. |
bulk_email | boolean | Optional | Indicates whether the notification is sent as a single mass email with all recipient addresses visible to each other. Possible values: true - The notification is sent as a bulk email, displaying all recipients together. false - The notification is not sent as a bulk email. |
created_by | Model | Optional | Expand List Email Notifications — response body — email notifications item created by User who created this email notification action. |
created_time | string | Optional | Represents the date and time when this email notification action was created, as generated by the server. Format: date-time Maximum length: 255 |
deletable | boolean | Optional | Indicates whether the current user has permission to delete this email notification action. Possible values: true - The current user can delete this action. false - The current user cannot delete this action. |
editable | boolean | Optional | Indicates whether the current user has permission to edit this email notification action. Possible values: true - The current user can edit this action. false - The current user cannot edit this action. |
feature_type | Model | Optional | Expand List Email Notifications — response body — email notifications item feature type Automation feature where this action is used. |
from_address | Model | Optional | Expand List Email Notifications — response body — email notifications item from address Sender address configuration used to send the notification email. |
id | string | Required within parent | Represents the unique identifier of the email notification action. Unique identifier of the email notification action. Maximum length: 20 |
lock_status | Model | Optional | Expand List Email Notifications — response body — email notifications item lock status Lock state of this action. Locked actions may not be editable or deletable. |
modified_by | Model | Optional | Expand List Email Notifications — response body — email notifications item modified by User who last modified this email notification action. |
modified_time | string | Optional | Represents the date and time when this email notification action was last modified, as generated by the server. Format: date-time Maximum length: 255 |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary CRM module where this notification action is configured. |
name | string | Required within parent | Represents the display name of the email notification action. Maximum length: 255 |
recipient_count | string | Optional | Represents the total number of configured recipients for this email notification action. Maximum length: 255 |
recipients | Model | Optional | Expand List Email Notifications — response body — email notifications item recipients Recipient configuration containing to, cc, and bcc collections. |
related_module | Model | Optional | Expand List Email Notifications — response body — email notifications item related module Related module context for this notification configuration; null when not applicable. |
reply_to_address | Model | Optional | Expand List Email Notifications — response body — email notifications item reply to address Reply-to address configuration for recipient replies. |
source | string | Optional | Represents the source application that created or manages this email notification action, for example, crm. Maximum length: 255 |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template used by this notification action. |
Referenced models: List Email Notifications — response body — email notifications item created by, List Email Notifications — response body — email notifications item lock status, List Email Notifications — response body — email notifications item modified by, List Email Notifications — response body — email notifications item module, List Email Notifications — response body — email notifications item template, List Email Notifications — response body — email notifications item feature type, List Email Notifications — response body — email notifications item related module, List Email Notifications — response body — email notifications item recipients, List Email Notifications — response body — email notifications item from address, List Email Notifications — response body — email notifications item reply to address
List Email Notifications — response body — email notifications item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the creator of a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who created the resource. Maximum length: 255 |
name | string | Optional | Represents the name of the user who created the resource. Maximum length: 255 |
List Email Notifications — response body — email notifications item lock status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates whether a particular component is locked, affecting its editability and usability. Additional keys: not allowed |
locked | boolean | Optional | Indicates whether the component is locked. Possible values: true - The component is locked and cannot be edited or used. false - The component is not locked and remains editable and usable. |
List Email Notifications — response body — email notifications item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the last person who modified a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who last modified the resource. Maximum length: 255 |
name | string | Optional | Represents the full name of the user who last modified the resource. Maximum length: 255 |
List Email Notifications — response body — email notifications item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the CRM module associated with an email notification definition. Both api_name and id are required and must refer to the same module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the CRM module whose records trigger the email notification. For example, Leads, Contacts, or Deals. Both api_name and id must refer to the same module. Maximum length: 255 |
id | string | Required within parent | Represents the unique numeric identifier of the CRM module. Both id and api_name must refer to the same module. Maximum length: 255 |
List Email Notifications — response body — email notifications item template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an email template reference used in an email notification definition. The template must belong to the same module as the notification, and both the id and name fields are required. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the email template. Maximum length: 255 |
name | string | Required within parent | Represents the name of the email template associated with the email notification. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / from_address / type: email details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the email details for the sender address associated with the notification. Additional keys: not allowed |
email | JSON | Required within parent | Represents the sender email address in the local@domain format. |
email (allOf 1) | string | All variants apply | Represents an email address in local@domain format, used for direct recipient and sender configurations. Format: email Maximum length: 255 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getemailnotificationsbyid. Catalog operation: getEmailNotificationsById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.