Zoho: Delete a custom field

← Fields operations · Get started

Operation zoho.deletecustomfield

Provider route: DELETE /crm/v8/settings/fields/{fieldId}. 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["fields"]["deleteCustomField"]>[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.fields.deleteCustomField(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.fields.delete_custom_field(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.fieldId	string	Required within parent	Id of the resource. Format: int64
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	The API name of the module to which the field belongs. Maximum length: 30

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
$	object	Root	Represents the response body for the field deletion operation, containing an array with one deletion result. Additional keys: not allowed
fields	array	Optional	Represents the list of field deletion results, containing one entry with the unique ID of the deleted field. Maximum items: 1
fields[]	Model	Each item	Expand Delete a custom field — response body — fields item

Referenced models: Delete a custom field — response body — fields item

Schemas

Delete a custom field — response body — fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a single field creation. Additional keys: not allowed
code	string	Required within parent	Represents the result code. Known values: SUCCESS
details	object	Required within parent	Represents the details of the created field. Additional keys: not allowed
details.id	string	Required within parent	Represents the ID of the created field. Maximum length: 25
message	string	Required within parent	Represents the result message. Maximum length: 225
status	string	Required within parent	Represents the status of the operation. Known values: success

Policy, approvals and errors

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