Skip to content

Zoho: Update an Email Notification by ID

Zoho emailNotifications.updateEmailNotification: arguments, response, policy and SDK examples.

← Email notifications operations · Get started

Operation zoho.updateemailnotification

Provider route: PUT /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"]["updateEmailNotification"]>[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.updateEmailNotification(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.update_email_notification(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
bodyModelOptionalExpand Update an Email Notification by ID — request body — body

Referenced models: Update an Email Notification by ID — request body — body

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

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

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

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

Update an Email Notification by ID — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response returned after updating an email notification definition in Zoho CRM. Contains the updated email notification details in the email_notifications array.
Additional keys: not allowed
email_notificationsarrayOptionalRepresents the list of updated email notification definitions. Contains one object with the details of the email notification that was updated.
Maximum items: 1
email_notifications[]ModelEach itemExpand Update an Email Notification by ID — response body — email notifications item

Referenced models: Update an Email Notification by ID — response body — email notifications item

Update an Email Notification by ID — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the request body wrapper for updating an email notification action. The body must contain an email_notifications array with exactly one object.
Additional keys: not allowed
email_notificationsarrayRequired within parentSpecify the email notification object to update. The array must contain exactly one object with the fields to modify.
Maximum items: 1
email_notifications[]ModelEach itemExpand Update an Email Notification by ID — request body — body email notifications item

Referenced models: Update an Email Notification by ID — request body — body email notifications item

Update an Email Notification by ID — response body — email notifications item
FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when a new email notification is created successfully, including the status code, status, and outcome message.
Additional keys: not allowed
codestringOptionalRepresents the status code returned after the email notification is created successfully.
Maximum length: 255
detailsModelOptionalExpand Update an Email Notification by ID — response body — email notifications item details
messagestringOptionalRepresents the message describing the outcome of the email notification creation request.
Maximum length: 255
statusstringOptionalRepresents the status of the email notification creation operation, indicating whether the request was successful.
Maximum length: 255

Referenced models: Update an Email Notification by ID — response body — email notifications item details

Update an Email Notification by ID — request body — body email notifications item
FieldTypePresenceDescription and constraints
$objectRootRepresents the writable fields for updating an email notification action in Zoho CRM. This is a partial-update schema — any key omitted from the payload retains its current stored value. Only the name, template, recipients, from_address, and reply_to_address fields can be modified. The module, related_module, bulk_email, and feature_type fields are immutable after creation.
Additional keys: not allowed
from_addressModelOptionalExpand 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.
namestringRequired within parentSpecify the display name of the email notification action. Special characters ~`#%^&*()+={}[]|;"<>\ are not allowed.
Maximum length: 255
recipientsModelRequired within parentExpand 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 (set during creation).
reply_to_addressModelOptionalExpand 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.
templateModelRequired within parentExpand 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. If no template exists yet for that module, create one first via the createEmailTemplate tool and then associate it here.

Referenced models: 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

Update an Email Notification by ID — response body — email notifications item details
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeRepresents the details of a recipient or sender entry in an email notification definition, including the email address, merge field API name, and merge field identifier.
Additional keys: not allowed
$ (anyOf 1).api_namestringOptionalRepresents the API name of the merge field used to resolve the email address dynamically. For example: ${!Deals.Contact_Name.Email}. Applicable only when the type is merge_field.
Maximum length: 100
$ (anyOf 1).emailstringOptionalRepresents the email address associated with the recipient or sender in the notification definition.
Maximum length: 255
$ (anyOf 1).idstringOptionalRepresents the unique identifier of the merge field. Applicable only when the type is merge_field.
Maximum length: 255
Create Email Notifications — request body — body email notifications item recipients
FieldTypePresenceDescription and constraints
$objectRootRepresents the recipient configuration for an email notification action, including primary, CC, and BCC recipient lists. The to field is mandatory and requires at least one entry. The cc and bcc fields are optional and are supported only when bulk_email is set to true. The to array can contain a maximum of 100 recipients, while the cc and bcc arrays can contain a maximum of 50 recipients each. A module can have one Multi-Select User Lookup field with up to 10 users; users selected through this lookup count toward the applicable recipient limit. For example, if 10 users are selected through the lookup, up to 90 additional recipients can be specified in the to array.
Additional keys: not allowed
bccarrayOptionalRepresents the BCC recipients of the email notification. Supported only when bulk_email is set to true.
Maximum items: 50
bcc[]ModelEach itemExpand Create Email Notifications — request body — body email notifications item recipients cc item
ccarrayOptionalRepresents the CC recipients of the email notification. Supported only when bulk_email is set to true.
Maximum items: 50
cc[]ModelEach itemExpand Create Email Notifications — request body — body email notifications item recipients cc item
toarrayRequired within parentRepresents the primary recipients of the email notification. At least one recipient entry is required.
Maximum items: 100
Minimum items: 1
to[]ModelEach itemExpand Create Email Notifications — request body — body email notifications item recipients cc item

Referenced models: Create Email Notifications — request body — body email notifications item recipients cc item

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
Create Email Notifications — request body — body / email_notifications / item / from_address / type: email
FieldTypePresenceDescription and constraints
$objectRootRepresents the sender address configuration for an email notification, used when the server assigns the address automatically or when the address resolves to a plain email address.
Additional keys: not allowed
detailsModelRequired within parentExpand List Email Notifications — response body — email_notifications / item / from_address / type: email details
resourcenullOptionalRepresents the resource reference for the sender address. This field is not applicable when the address type is email.
typestringRequired within parentRepresents the type of sender address for the notification.
Possible values:
email - The sender address resolves to a plain email address.
One of: email
Maximum length: 255

Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: email details

SDK function policy ID: zoho.updateemailnotification. Catalog operation: updateEmailNotification. 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.