Skip to content

Zoho: Delete Email Notifications

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

← Email notifications operations · Get started

Operation zoho.deleteemailnotifications

Provider route: DELETE /crm/v8/settings/automation/email_notifications. 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"]["deleteEmailNotifications"]>[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.deleteEmailNotifications(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.delete_email_notifications(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.idsstringRequired within parentMaximum length: 250

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Success Response
$ (anyOf 2)ModelAlternativeExpand Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Mixed Response

Referenced models: Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Mixed Response, Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Success Response

Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Mixed Response
FieldTypePresenceDescription and constraints
$objectRootRepresents the partial-success response for a bulk delete request, containing a mix of successful and failed deletion results for the requested email notification IDs.
Additional keys: not allowed
email_notificationsarrayRequired within parentRepresents the per-ID deletion results for the bulk delete request.
Maximum items: 10
email_notifications[]JSONEach item
email_notifications[] (anyOf 1)ModelAlternativeExpand Delete Email Notifications — response body — email notifications email notifications item
email_notifications[] (anyOf 2)ModelAlternativeExpand Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error

Referenced models: Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error, Delete Email Notifications — response body — email notifications email notifications item

Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Success Response
FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when all requested email notification definitions are successfully deleted.
Additional keys: not allowed
email_notificationsarrayRequired within parentRepresents the list of deletion result entries for each email notification ID included in the request.
Maximum items: 3
email_notifications[]ModelEach itemExpand Delete Email Notifications — response body — email notifications email notifications item

Referenced models: Delete Email Notifications — response body — email notifications email notifications item

Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error
FieldTypePresenceDescription and constraints
$objectRootRepresents the result of a failed deletion for a single record ID during a bulk delete operation, including the failure code, status, and error message.
Additional keys: not allowed
codestringRequired within parentRepresents the failure code indicating why the bulk delete operation failed for this record.
Possible values:
INVALID_DATA - The data provided for the record is invalid.
NOT_ALLOWED - The delete operation is not permitted for this record.
Known values: INVALID_DATA, NOT_ALLOWED
detailsModelRequired within parentExpand Delete an Email Notification by ID — response body — email notifications item details
messagestringRequired within parentRepresents the error message describing why the bulk delete operation failed for this record.
Maximum length: 255
statusstringRequired within parentRepresents the status of the bulk delete operation for this record.
Possible values:
error - Indicates that the delete operation failed for this record.
Known values: error

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

Delete Email Notifications — response body — email notifications email notifications item
FieldTypePresenceDescription and constraints
$objectRootRepresents the result item returned for a record that was successfully deleted in a bulk delete operation.
Additional keys: not allowed
codestringRequired within parentRepresents the result code for a successfully deleted record in a bulk delete operation.
Possible values:
SUCCESS - Indicates that the record was deleted successfully.
Known values: SUCCESS
detailsModelRequired within parentExpand Delete an Email Notification by ID — response body — email notifications item details
messagestringRequired within parentRepresents the success message returned when a record is deleted successfully in a bulk delete operation.
Maximum length: 255
statusstringRequired within parentRepresents the operation status of a bulk delete item.
Possible values:
success - Indicates that the deletion of the record was completed successfully.
Known values: success

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

Delete an Email Notification by ID — response body — email notifications item details
FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier details for a bulk-delete result item, including the unique ID of the email notification for which the result applies.
Additional keys: not allowed
idstringRequired within parentRepresents the unique ID of the email notification for which this bulk-delete result applies.
Maximum length: 20

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