Zoho: Specific variable — variables update Variable By Id

← Variables operations · Get started

Operation zoho.updatevariablebyid

Provider route: PUT /crm/v8/settings/variables/{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["variables"]["updateVariableById"]>[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.variables.updateVariableById(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.variables.update_variable_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
body	Model	Optional	Expand Specific variable — variables update Variable By Id — request body — body

Referenced models: Specific variable — variables update Variable By Id — 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 Specific variable — variables update Variable By Id — response body

Referenced models: Specific variable — variables update Variable By Id — response body

Schemas

Specific variable — variables update Variable By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response summarizing scoped batch updates with an array of per-item operation results. Additional keys: not allowed
variables	array	Optional	Array of variable update items to process. Maximum items: 1
variables[]	Model	Each item	Expand Delete variables — response body — variables item

Referenced models: Delete variables — response body — variables item

Specific variable — variables update Variable By Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Alternate instance of the scoped batch update request wrapper for variable updates. Additional keys: not allowed
variables	array	Required within parent	Array of variable update items to process. Mandatory. Maximum items: 1
variables[]	Model	Each item	Expand Update variables — request body — body variables item

Referenced models: Update variables — request body — body variables item

Delete variables — response body — variables item

Field	Type	Presence	Description and constraints
$	object	Root	Per-item outcome for a variable operation, including code, message, status, and details such as the resulting variable id. Additional keys: not allowed
code	string	Optional	The result code of the operation (for example, SUCCESS, INVALID_DATA). Maximum length: 255
details	Model	Optional	Expand Delete variables — response body — variables item details
message	string	Optional	A human-readable message describing the result of the operation. Maximum length: 255
status	string	Optional	The status of the operation (for example, success or error). Maximum length: 255

Referenced models: Delete variables — response body — variables item details

Update variables — request body — body variables item

Field	Type	Presence	Description and constraints
$	object	Root	Object used to update a variable's value within a scoped resource context; accepts id and the new value. Additional keys: not allowed
id	string	Required within parent	Id of variables Format: int64 Maximum length: 19
value	string or null	Required within parent	describes value for the variables Maximum length: 3000

Delete variables — response body — variables item details

Field	Type	Presence	Description and constraints
$	object	Root	Details of an individual variable operation result, including the id of the affected variable. Additional keys: not allowed
api_name	string	Optional	The API name of the affected variable. Maximum length: 100
id	string	Optional	The unique ID of the affected variable. Format: int64
json_path	string	Optional	The JSON path to the field that caused the error. Maximum length: 255

Policy, approvals and errors

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