Zoho: Replace Pick list values

← Pick list values operations · Get started

Operation zoho.postreplacepicklistvalues

Provider route: POST /crm/v8/settings/fields/{fieldId}/actions/replace_pick_list_values. 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"]["postReplacePickListValues"]>[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.postReplacePickListValues(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.post_replace_pick_list_values(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
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 50 Minimum length: 1
body	Model	Optional	Expand Replace Pick list values — request body — body

Referenced models: Replace Pick list values — request body — body

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 Replace Pick list values — response body

Referenced models: Replace Pick list values — response body

Schemas

Replace Pick list values — response body

Field	Type	Presence	Description and constraints
$	object	Root	Accepted response indicating picklist replace operations have been scheduled. Returns an array of scheduling results. Additional keys: not allowed
replace_pick_list_values	array	Required within parent	Description of the replace option on schedule Maximum items: 1 Minimum items: 1
replace_pick_list_values[]	Model	Each item	Expand Replace Pick list values — response body — replace pick list values item

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

Replace Pick list values — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Container for the replace_pick_list_values array, listing one or more instructions to perform picklist value replacements. Additional keys: not allowed
replace_pick_list_values	array	Required within parent	Replace picklist value with from and to options (Required) Maximum items: 1 Minimum items: 1
replace_pick_list_values[]	Model	Each item	Expand Replace Pick list values — request body — body replace pick list values item

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

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

Field	Type	Presence	Description and constraints
$	object	Root	Result entry for a scheduled replace operation, including status, code, message, and asynchronous job details. Additional keys: not allowed
code	string	Required within parent	Code of the scheduler response 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	Message of the scheduled details Known values: Picklist option replace operation scheduled successfully
status	string	Required within parent	status on replace operation of the scheduler 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 — request body — body replace pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	A structured instruction that pairs a source and target picklist option, with an option to delete the source after replacement. Additional keys: not allowed
delete_old_value	boolean or null	Optional	Boolean value to delete the old_value along with replace
new_value	Model	Required within parent	Expand Replace Pick list values — request body — body replace pick list values item new value The option to be replaced with the option (Required)
old_value	Model	Required within parent	Expand Replace Pick list values — request body — body replace pick list values item old value The option which is to be replaced (Required)

Referenced models: Replace Pick list values — request body — body replace pick list values item old value, Replace Pick list values — request body — body replace pick list values item new value

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

Replace Pick list values — request body — body replace pick list values item old value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the picklist option to be replaced, providing the display value and unique identifier. At least one of id or display_value must be provided. Additional keys: not allowed
display_value	string or null	Optional	Specify the display value of the option to be replaced Maximum length: 120
id	string or null	Optional	Specify the option id which is to be replaced (Unique) Format: int64 Maximum length: 20 Minimum length: 13
$ (anyOf 1)	JSON	Alternative
$ (anyOf 2)	JSON	Alternative

Replace Pick list values — request body — body replace pick list values item new value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the picklist option that will act as the replacement, providing the display value and unique identifier. At least one of id or display_value must be provided. Additional keys: not allowed
display_value	string or null	Optional	Display value of the option Maximum length: 120
id	string or null	Optional	The option id (Unique) Format: int64 Maximum length: 20 Minimum length: 13
$ (anyOf 1)	JSON	Alternative
$ (anyOf 2)	JSON	Alternative

Policy, approvals and errors

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