Zoho: Delete a picklist field option

← Pick list values operations · Get started

Operation zoho.deletepicklistvaluesbypicklistvalueid

Provider route: DELETE /crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}. 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["pickListValues"]["deletePickListValuesByPickListValueid"]>[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.pickListValues.deletePickListValuesByPickListValueid(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.pick_list_values.delete_pick_list_values_by_pick_list_valueid(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	Format: int64 Minimum length: 1
path.pickListValueId	string	Required within parent	Format: int64 Maximum length: 255
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 50 Minimum length: 1

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 a picklist field option — response body — pick list values — Direct Picklist Option Deletion Response
$ (anyOf 2)	Model	Alternative	Expand Delete a picklist field option — response body — pick list values — Picklist Option Deletion Response

Referenced models: Delete a picklist field option — response body — pick list values — Direct Picklist Option Deletion Response, Delete a picklist field option — response body — pick list values — Picklist Option Deletion Response

Schemas

Delete a picklist field option — response body — pick list values — Direct Picklist Option Deletion Response

Field	Type	Presence	Description and constraints
$	object	Root	Success response indicating picklist option has been deleted directly. Returns an array of deletion results. Additional keys: not allowed
pick_list_values	array	Required within parent	pick list values Maximum items: 1 Minimum items: 0
pick_list_values[]	Model	Each item	Expand Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result

Referenced models: Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result

Delete a picklist field option — response body — pick list values — Picklist Option Deletion Response

Field	Type	Presence	Description and constraints
$	object	Root	Accepted response indicating picklist option deletion has been scheduled. Returns an array of deletion results. Additional keys: not allowed
pick_list_values	array	Required within parent	pick list values Maximum items: 1 Minimum items: 0
pick_list_values[]	Model	Each item	Expand Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result

Referenced models: Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result

Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result

Field	Type	Presence	Description and constraints
$	object	Root	Represents a direct (non-scheduled) deletion result for a picklist option, including status, code, message, and deleted option ID. Additional keys: not allowed
code	string	Required within parent	Picklist option deletion result code Known values: SUCCESS
details	object	Required within parent	Details of the deleted picklist option Additional keys: not allowed
details.id	string	Required within parent	The unique ID of the deleted picklist option Format: int64 Maximum length: 100 Minimum length: 13
message	string	Required within parent	Picklist option deletion message Known values: PickList Option deleted successfully
status	string	Required within parent	Picklist option deletion status Known values: success Maximum length: 7 Minimum length: 5

Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result

Field	Type	Presence	Description and constraints
$	object	Root	Represents the scheduled deletion outcome for a picklist option, including status, code, message, and async job details. Additional keys: not allowed
code	string	Required within parent	picklist option deletion code Known values: SCHEDULED
details	Model	Required within parent	Expand Replace Pick list values — response body — replace pick list values item details
message	string	Required within parent	Picklist option deletion message Known values: Picklist Option deletion scheduled successfully
status	string	Required within parent	Picklist option deletion status Known values: success Maximum length: 7 Minimum length: 5

Referenced models: Replace Pick list values — response body — replace pick list values item details

Replace Pick list values — response body — replace pick list values item details

Field	Type	Presence	Description and constraints
$	object	Root	Contains the scheduler job identifier for an asynchronous operation that was accepted for processing. Additional keys: not allowed
job_id	string	Required within parent	scheduler jobid Format: int64 Maximum length: 20 Minimum length: 13

Policy, approvals and errors

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