Zoho: Create variables

← Variables operations · Get started

Operation zoho.createvariables

Provider route: POST /crm/v8/settings/variables. 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"]["createVariables"]>[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.createVariables(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.create_variables(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Create variables — request body — body

Referenced models: Create variables — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create variables — response body — variables — Variables Batch Operation Created
$ (anyOf 2)	Model	Alternative	Expand Create variables — response body — variables — Variables Batch Operation Multi Status

Referenced models: Create variables — response body — variables — Variables Batch Operation Created, Create variables — response body — variables — Variables Batch Operation Multi Status

Schemas

Create variables — response body — variables — Variables Batch Operation Created

Field	Type	Presence	Description and constraints
$	object	Root	Summary response for a batch variables operation where all items are created successfully. Includes an array of per-item results. Additional keys: not allowed
variables	array	Optional	Array of operation results for each created variable. Maximum items: 5
variables[]	Model	Each item	Expand Delete variables — response body — variables item

Referenced models: Delete variables — response body — variables item

Create variables — response body — variables — Variables Batch Operation Multi Status

Field	Type	Presence	Description and constraints
$	object	Root	Batch response indicating mixed successes and failures. Contains a variables array with per-item outcomes and related details. Additional keys: not allowed
variables	array	Optional	Array of per-item operation results indicating success or failure for each variable. Maximum items: 2
variables[]	Model	Each item	Expand Delete variables — response body — variables item

Referenced models: Delete variables — response body — variables item

Create variables — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body wrapper that carries an array of variable definitions to be processed in a single batch. Additional keys: not allowed
variables	array	Required within parent	Array of variable definitions to create. Maximum: 25 items. Maximum items: 2
variables[]	Model	Each item	Expand Create variables — request body — body variables item

Referenced models: Create 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

Create variables — request body — body variables item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a variable to create, including api_name, name, optional description, data type (text, integer, boolean, date, float), initial value, and the target variable_group reference. Additional keys: not allowed
api_name	string	Required within parent	Specify the API name of the variables. Maximum length: 100 Pattern: ^[a-zA-Z]+\w*[a-zA-Z0-9]*$
description	string or null	Optional	Specify the description of the variables. Maximum length: 250
name	string	Required within parent	Specify the name of the variables. Maximum length: 50
type	string	Required within parent	Specify the type of the variables One of: text, integer, boolean, date, float Maximum length: 7
value	integer or null	Optional	Initial value of variable Format: int32
variable_group	Model	Required within parent	Expand Create variables — request body — body variables item variable group Variable Groups json object (Required)

Referenced models: Create variables — request body — body variables item variable group

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

Create variables — request body — body variables item variable group

Field	Type	Presence	Description and constraints
$	object	Root	Nested object that identifies the variable group when defining a variable. Includes the group's id (required). Additional keys: not allowed
id	string	Required within parent	The unique ID of the variable group. Mandatory. Format: int64

Policy, approvals and errors

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