Zoho: Related Notes — related Notes delete Bulk Notes

← Related notes operations · Get started

Operation zoho.deletebulknotes

Provider route: DELETE /crm/v8/{parentRecordModule}/{parentRecordId}/Notes. Alter supplies the connection’s credentials and routing.

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["relatedNotes"]["deleteBulkNotes"]>[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.relatedNotes.deleteBulkNotes(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.related_notes.delete_bulk_notes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.parentRecordModule	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
path.parentRecordId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
query	object	Required within parent	Additional keys: not allowed
query.ids	string	Required within parent	Maximum length: 2000 Pattern: ^[0-9]+(,[0-9]+)*$

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)	object	Alternative	Success response for bulk note deletion, containing the action status for each deleted note. Additional keys: not allowed
$ (anyOf 1).data	array	Required within parent	JSON array representing the list of action status objects for each note deleted in this request. Maximum items: 200
$ (anyOf 1).data[]	object	Each item	Represents the action status for an individual note deletion. Additional keys: not allowed
$ (anyOf 1).data[].code	string	Required within parent	The result code indicating the outcome of the requested note deletion. Known values: SUCCESS
$ (anyOf 1).data[].details	object	Required within parent	Contains the details of the deleted note record. Additional keys: not allowed
$ (anyOf 1).data[].details.id	string	Required within parent	Represents the unique identifier of the deleted note. Format: int64
$ (anyOf 1).data[].message	string	Required within parent	Represents the result message for this requested note deletion Maximum length: 500
$ (anyOf 1).data[].status	string	Required within parent	Represents the status of this requested note deletion. Known values: success
$ (anyOf 2)	object	Alternative	Mixed-status response for bulk note deletion where some notes were deleted successfully and others failed. Additional keys: not allowed
$ (anyOf 2).data	array	Required within parent	Represents the list of mixed action status objects for each note in this request. Maximum items: 200
$ (anyOf 2).data[]	JSON	Each item	Represents an individual note deletion result, which may be a success or an error.
$ (anyOf 2).data[] (anyOf 1)	object	Alternative	Successful note deletion result with action status and note identifier. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).code	string	Required within parent	The result code indicating the outcome of deleting the requested note. Known values: SUCCESS
$ (anyOf 2).data[] (anyOf 1).details	object	Required within parent	Contains the details of the deleted note record. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).details.id	string	Required within parent	Represents the unique identifier of the deleted note. Format: int64
$ (anyOf 2).data[] (anyOf 1).message	string	Required within parent	Represents the result message for deleting the requested note. Maximum length: 500
$ (anyOf 2).data[] (anyOf 1).status	string	Required within parent	Represents the status of deleting the note. Known values: success
$ (anyOf 2).data[] (anyOf 2)	object	Alternative	Failed note deletion result with error code and details. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 2).code	string	Required within parent	Represents the error code for this note deletion failure. Known values: INVALID_DATA
$ (anyOf 2).data[] (anyOf 2).details	object	Required within parent	Contains additional details about the note deletion error. Additional keys: allowed
$ (anyOf 2).data[] (anyOf 2).details.id	string	Optional	Represents the identifier of the note that failed to delete. Format: int64
$ (anyOf 2).data[] (anyOf 2).message	string	Required within parent	Represents the error message for failure of the requested note deletion. Maximum length: 500
$ (anyOf 2).data[] (anyOf 2).status	string	Required within parent	Represents the status of failure of note deletion. Known values: error

Policy, approvals and errors

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