Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentMaximum length: 20
queryobjectOptionalAdditional keys: not allowed
query.include_inner_detailsstringOptionalOne of: module.plural_label, related_module.plural_label, from_address.field_label

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get an Email Notification by ID — response body

Referenced models: Get an Email Notification by ID — response body

28 more schemas are linked from the tables above, on the schema pages.

Get an Email Notification by ID — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_notificationsarrayOptionalRepresents 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[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
associatedbooleanOptionalIndicates 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_emailbooleanOptionalIndicates 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_byModelOptionalExpand List Email Notifications — response body — email notifications item created by
User who created this email notification action.
created_timestringOptionalRepresents the date and time when this email notification action was created, as generated by the server.
Format: date-time
Maximum length: 255
deletablebooleanOptionalIndicates 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.
editablebooleanOptionalIndicates 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_typeModelOptionalExpand List Email Notifications — response body — email notifications item feature type
Automation feature where this action is used.
from_addressModelOptionalExpand List Email Notifications — response body — email notifications item from address
Sender address configuration used to send the notification email.
idstringRequired within parentRepresents the unique identifier of the email notification action.
Unique identifier of the email notification action.
Maximum length: 20
lock_statusModelOptionalExpand List Email Notifications — response body — email notifications item lock status
Lock state of this action. Locked actions may not be editable or deletable.
modified_byModelOptionalExpand List Email Notifications — response body — email notifications item modified by
User who last modified this email notification action.
modified_timestringOptionalRepresents the date and time when this email notification action was last modified, as generated by the server.
Format: date-time
Maximum length: 255
moduleModelRequired within parentExpand List Email Notifications — response body — email notifications item module
Primary CRM module where this notification action is configured.
namestringRequired within parentRepresents the display name of the email notification action.
Maximum length: 255
recipient_countstringOptionalRepresents the total number of configured recipients for this email notification action.
Maximum length: 255
recipientsModelOptionalExpand List Email Notifications — response body — email notifications item recipients
Recipient configuration containing to, cc, and bcc collections.
related_moduleModelOptionalExpand List Email Notifications — response body — email notifications item related module
Related module context for this notification configuration; null when not applicable.
reply_to_addressModelOptionalExpand List Email Notifications — response body — email notifications item reply to address
Reply-to address configuration for recipient replies.
sourcestringOptionalRepresents the source application that created or manages this email notification action, for example, crm.
Maximum length: 255
templateModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the creator of a resource, including their name and unique identifier.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the user who created the resource.
Maximum length: 255
namestringOptionalRepresents the name of the user who created the resource.
Maximum length: 255
List Email Notifications — response body — email notifications item lock status
FieldTypePresenceDescription and constraints
$objectRootIndicates whether a particular component is locked, affecting its editability and usability.
Additional keys: not allowed
lockedbooleanOptionalIndicates 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the last person who modified a resource, including their name and unique identifier.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the user who last modified the resource.
Maximum length: 255
namestringOptionalRepresents the full name of the user who last modified the resource.
Maximum length: 255
List Email Notifications — response body — email notifications item module
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_namestringRequired within parentRepresents 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
idstringRequired within parentRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
idstringRequired within parentRepresents the unique identifier of the email template.
Maximum length: 255
namestringRequired within parentRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the email details for the sender address associated with the notification.
Additional keys: not allowed
emailJSONRequired within parentRepresents the sender email address in the local@domain format.
email (allOf 1)stringAll variants applyRepresents an email address in local@domain format, used for direct recipient and sender configurations.
Format: email
Maximum length: 255
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.