Zoho: Update a Global Picklist by ID

← Global picklists operations · Get started

Operation zoho.updateglobalpicklistbyid

Provider route: PATCH /crm/v8/settings/global_picklists/{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["globalPicklists"]["updateGlobalPicklistById"]>[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.globalPicklists.updateGlobalPicklistById(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.global_picklists.update_global_picklist_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	Format: int64
body	object	Required within parent	Request body for updating a global picklist. Additional keys: not allowed
body.global_picklists	array	Required within parent	Array containing the global picklist to update. Maximum items: 1
body.global_picklists[]	object	Each item	Global picklist object with update details. Additional keys: not allowed
body.global_picklists[].api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
body.global_picklists[].description	string or null	Optional	Updated description of the global picklist. Maximum length: 1000
body.global_picklists[].display_label	string	Optional	Updated display label of the global picklist. Maximum length: 50
body.global_picklists[].pick_list_values	array	Optional	Array of picklist values to add, update, or delete. For updates, include id and fields to update. For deletion, include id and _delete: true. Only one value can be moved to unused or deleted per request. Maximum items: 5000
body.global_picklists[].pick_list_values[]	Model	Each item	Expand Update a Global Picklist — request body — body global picklists item pick list values item
body.global_picklists[].pick_list_values_sorted_lexically	boolean	Optional	Indicates if picklist values should be sorted lexically.

Referenced models: Update a Global Picklist — request body — body global picklists item pick list values item

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	Response object for successful update of a global picklist. Additional keys: not allowed
global_picklists	array	Required within parent	Array containing the updated global picklist response. Maximum items: 1
global_picklists[]	Model	Each item	Expand Update a Global Picklist — response body — global picklists item

Referenced models: Update a Global Picklist — response body — global picklists item

Schemas

Update a Global Picklist — response body — global picklists item

Field	Type	Presence	Description and constraints
$	object	Root	Updated global picklist response details. Additional keys: not allowed
code	string	Required within parent	Response code indicating successful update. Known values: SUCCESS
details	object	Required within parent	Details of the updated global picklist. Additional keys: not allowed
details.id	string	Required within parent	Id of the resource. Format: int64
message	string	Required within parent	Human-readable success message. Maximum length: 255
status	string	Required within parent	Status of the operation. Known values: success

Update a Global Picklist — request body — body global picklists item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Picklist value object for update/add/delete. Additional keys: not allowed
_delete	boolean	Optional	Set to true to delete this picklist value. Only one value can be deleted per request.
display_value	string	Optional	The picklist display value(translated value if translation enabled). Maximum length: 120
id	string	Optional	Id of the resource. Format: int64
reference_value	string	Optional	Reference value of the picklist field. Maximum length: 120
type	string	Optional	Type of the picklist value (used or unused). Only one value can be moved to unused per request. One of: unused, used

Policy, approvals and errors

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