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.
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"]["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 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.delete_email_notifications(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.ids | string | Required within parent | Maximum length: 250 |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Success Response |
$ (anyOf 2) | Model | Alternative | Expand 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
Schemas
Section titled “Schemas”Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Mixed Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_notifications | array | Required within parent | Represents the per-ID deletion results for the bulk delete request. Maximum items: 10 |
email_notifications[] | JSON | Each item | |
email_notifications[] (anyOf 1) | Model | Alternative | Expand Delete Email Notifications — response body — email notifications email notifications item |
email_notifications[] (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when all requested email notification definitions are successfully deleted. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the list of deletion result entries for each email notification ID included in the request. Maximum items: 3 |
email_notifications[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Required within parent | Represents 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 |
details | Model | Required within parent | Expand Delete an Email Notification by ID — response body — email notifications item details |
message | string | Required within parent | Represents the error message describing why the bulk delete operation failed for this record. Maximum length: 255 |
status | string | Required within parent | Represents 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result item returned for a record that was successfully deleted in a bulk delete operation. Additional keys: not allowed |
code | string | Required within parent | Represents 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 |
details | Model | Required within parent | Expand Delete an Email Notification by ID — response body — email notifications item details |
message | string | Required within parent | Represents the success message returned when a record is deleted successfully in a bulk delete operation. Maximum length: 255 |
status | string | Required within parent | Represents 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
id | string | Required within parent | Represents the unique ID of the email notification for which this bulk-delete result applies. Maximum length: 20 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.