Zoho: Create Email Notifications
Zoho emailNotifications.postEmailNotifications: arguments, response, policy and SDK examples.
← Email notifications operations · Get started
Operation zoho.postemailnotifications
Provider route: POST /crm/v8/settings/automation/email_notifications. 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"]["postEmailNotifications"]>[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.postEmailNotifications(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.post_email_notifications(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create Email Notifications — request body — body |
Referenced models: Create Email Notifications — request body — body
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 Create Email Notifications — response body |
Referenced models: Create Email Notifications — response body
Schemas
Section titled “Schemas”28 more schemas are linked from the tables above, on the schema pages.
Create Email Notifications — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body wrapper for creating an email notification action. The body must contain an email_notifications array with exactly one object. Additional keys: not allowed |
email_notifications | array | Required within parent | Specify the email notification objects to create. The array must contain exactly one object. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Create Email Notifications — request body — body email notifications item |
Referenced models: Create Email Notifications — request body — body email notifications item
Create Email Notifications — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when an email notification is successfully created in the Zoho CRM organization. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the list of email notification objects created in the request. Contains one item representing the successfully created email notification. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Create Email Notifications — response body — email notifications item |
Referenced models: Create Email Notifications — response body — email notifications item
Create Email Notifications — request body — body email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the writable fields for creating an email notification action in Zoho CRM. The module, name, recipients (with at least one entry in the to array), and template fields are required. Optionally configure from_address, reply_to_address, related_module, bulk_email, and feature_type. Additional keys: not allowed |
bulk_email | boolean | Optional | Indicates whether mass email mode is enabled for this notification. When set to true, CC and BCC recipients are allowed in the recipients object; when omitted or set to false, including CC or BCC recipients returns an AMBIGUITY_DURING_PROCESSING error. When true, role, group, territory, role_and_subordinate, and territory_and_subterritory recipient types cannot be specified in the recipients.to array; use individual users or email addresses instead. This value cannot be changed after creation. Possible values: true - Mass email mode is enabled; CC and BCC recipients are permitted. false - Mass email mode is disabled; CC and BCC recipients are not permitted. Default: false |
feature_type | Model | Optional | Expand Create Email Notifications — request body — body email notifications item feature type Automation feature this email notification belongs to. Defaults to 'workflow' if omitted. All listed values are supported for creation via API. |
from_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item from address Sender (From) address. Supported types: merge_field, user, organization_email. When bulk_email is false, the From address defaults to notifications@example.com for notifications sent to internal CRM users; from_address must not be specified in this case and doing so returns DEPENDENT_MISMATCH. When bulk_email is true, the configured From address is used instead of notifications@example.com, and the From address is required for mass emails. |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary CRM module whose records trigger this email notification (e.g., Leads, Contacts, Deals). Both api_name and id are required. If they mismatch, returns AMBIGUITY_DURING_PROCESSING. This value cannot be changed after creation. Use GET /settings/modules to discover available modules. |
name | string | Required within parent | Specify the display name of the email notification action. The following special characters are not allowed: ~`#%^&*()+={}[]|;"<>\. Maximum length: 255 |
recipients | Model | Required within parent | Expand Create Email Notifications — request body — body email notifications item recipients Recipients of the email notification. Provide a JSON object with three arrays: to (required, at least one entry), cc (optional), and bcc (optional). CC and BCC are only allowed when bulk_email is true. |
related_module | Model | Optional | Expand Create Email Notifications — request body — body email notifications item related module Related module context for this notification configuration (e.g., Notes as related module for a Leads notification). This value cannot be changed after creation. Pass null when not applicable. |
reply_to_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item reply to address Reply-to address. Supported types: merge_field, user, organization_email. When all recipients are internal CRM users, reply_to_address must not be specified and doing so returns DEPENDENT_MISMATCH. Required when any recipient resolves to an external email. |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template to be used for this notification action. Both name and id are required. Fetch available templates from the Email Templates API for the configured module. If no template exists yet for that module, create one first via the createEmailTemplate tool and then associate it here. Templates containing Consent or Survey links are not supported for mass emails; do not use a template containing these links when bulk_email is set to true. |
Referenced models: Create Email Notifications — request body — body email notifications item feature type, List Email Notifications — response body — email notifications item module, Create Email Notifications — request body — body email notifications item related module, Create Email Notifications — request body — body email notifications item recipients, List Email Notifications — response body — email notifications item template, Create Email Notifications — request body — body email notifications item from address, Create Email Notifications — request body — body email notifications item reply to address
Create Email Notifications — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single success result item returned when an email notification action is created successfully in Zoho CRM. Additional keys: not allowed |
code | string | Required within parent | Represents the result code for the email notification creation operation. Possible values: SUCCESS - The email notification action was created successfully. Known values: SUCCESS |
details | Model | Required within parent | Expand Create Email Notifications — response body — email notifications item details |
message | string | Required within parent | Represents the success message returned after the email notification action is created. Maximum length: 255 |
status | string | Required within parent | Represents the status of the email notification creation operation. Possible values: success - The email notification action was created successfully. Known values: success |
Referenced models: Create Email Notifications — response body — email notifications item details
Create Email Notifications — request body — body email notifications item feature type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Represents the automation feature this email notification is associated with. Possible values: workflow - Standard workflow rules. approval_process - Approval workflows. blueprint - Blueprint automation stages. blueprint_transition - Blueprint automation stages (transition level). blueprint_state - Blueprint automation stages (state level). review_process - Review process actions. orchestration - Orchestration flows. assignment_rules - Lead and record assignment rules. kiosk - Kiosk mode actions. pathfinder - Pathfinder actions. connected_workflows - Connected workflow chains. commandcenter_service - CommandCenter service. cadences - Cadence and sequence actions. One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences 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 |
Create Email Notifications — request body — body email notifications item related module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | Represents the related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the related CRM module used in the automation configuration, for example, Notes. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the related CRM module that corresponds to the api_name value. Maximum length: 255 |
Create Email Notifications — response body — email notifications item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier details returned for the created email notification action. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the newly created email notification action. Maximum length: 20 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.postemailnotifications. Catalog operation: postEmailNotifications. 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.