Zoho: Delete Field Update

← Field updates operations · Get started

Operation zoho.deletefieldupdatebyid

Provider route: DELETE /crm/v8/settings/automation/field_updates/{id}. 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["fieldUpdates"]["deleteFieldUpdateById"]>[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.fieldUpdates.deleteFieldUpdateById(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.field_updates.delete_field_update_by_id(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.id	string	Required within parent	Maximum length: 255

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 Delete Field Update — response body

Referenced models: Delete Field Update — response body

Schemas

Delete Field Update — response body

Field	Type	Presence	Description and constraints
$	object	Root	Indicates that the field update was deleted successfully. Additional keys: not allowed
field_updates	array	Optional	Array containing the deleted field update action. Contains exactly one item. Maximum items: 1
field_updates[]	Model	Each item	Expand Create Field Update — response body — field updates item

Referenced models: Create Field Update — response body — field updates item

Create Field Update — response body — field updates item

Field	Type	Presence	Description and constraints
$	object	Root	Result object for a field update create, update, or delete operation. Contains the operation outcome code, a human-readable message, the status, and details including the server-generated ID. Additional keys: not allowed
code	string	Required within parent	Operation result code. 'SUCCESS' for successful operations. In bulk operations (DELETE 207), individual items may return error codes like 'NOT_ALLOWED' or 'INVALID_DATA'. Known values: SUCCESS, NOT_ALLOWED, INVALID_DATA Maximum length: 255
details	Model	Required within parent	Expand Create Field Update — response body — field updates item details
message	string	Required within parent	Human-readable message describing the operation outcome. Maximum length: 255
status	string	Required within parent	Overall status of the operation. 'success' for successful operations, 'error' for failed individual items in bulk operations. Known values: success, error Maximum length: 255

Referenced models: Create Field Update — response body — field updates item details

Create Field Update — response body — field updates item details

Field	Type	Presence	Description and constraints
$	object	Root	Details object within an action result, containing the server-generated unique identifier of the created, updated, or deleted field update action. Additional keys: not allowed
id	string	Required within parent	Unique identifier of the field update action that was created, updated, or deleted. Maximum length: 255

Policy, approvals and errors

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