Zoho: Variables schemas

← Variables operations · All schemas

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

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

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

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

Delete variables — response body

Field	Type	Presence	Description and constraints
$	object	Root	Batch removal response indicating mixed outcomes for multiple variables, with per-item result details. Additional keys: not allowed
variables	array	Optional	Array of operation results for each deleted variable. Maximum items: 6
variables[]	Model	Each item	Expand Delete variables — response body — variables item

Referenced models: Delete variables — response 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

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

Generate API Name — variables post Generate Api Name — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Alternate request payload wrapper containing items used to generate API names. Additional keys: not allowed
variables	array	Required within parent	Array of variable definitions. Mandatory. Maximum items: 1
variables[]	Model	Each item	Expand Generate API Name — variables post Generate Api Name — request body — body variables item

Referenced models: Generate API Name — variables post Generate Api Name — request body — body variables item

Generate API Name — variables post Generate Api Name — request body — body variables item

Field	Type	Presence	Description and constraints
$	object	Root	Alternate input item for API name generation, specifying the variable name and group. Additional keys: not allowed
name	string	Required within parent	The display name for the variable. Mandatory. Maximum length: 50
variable_group	Model	Required within parent	Expand specific variable — response body — variables item variable group The variable group to which this variable belongs. Mandatory.

Referenced models: specific variable — response body — variables item variable group

Generate API Name — variables post Generate Api Name — response body

Field	Type	Presence	Description and constraints
$	object	Root	200 response providing generated API names for the submitted variables. Additional keys: not allowed
variables	array	Optional	Array of results for the API name generation operation. Maximum items: 1
variables[]	Model	Each item	Expand Generate API Name — variables post Generate Api Name — response body — variables item

Referenced models: Generate API Name — variables post Generate Api Name — response body — variables item

Generate API Name — variables post Generate Api Name — response body — variables item

Field	Type	Presence	Description and constraints
$	object	Root	Per-item result for a variable operation, providing a code, message, status, and details such as the variable ID. Additional keys: not allowed
code	string	Optional	The result code of the operation (for example, SUCCESS). Maximum length: 255
details	Model	Optional	Expand Generate API Name — variables post Generate Api Name — 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: Generate API Name — variables post Generate Api Name — response body — variables item details

Generate API Name — variables post Generate Api Name — response body — variables item details

Field	Type	Presence	Description and constraints
$	object	Root	Minimal details about a variable operation, including the server-assigned variable identifier. Additional keys: not allowed
api_name	string	Optional	The API name of the variable. Maximum length: 255
id	string	Optional	The unique ID of the variable. Format: int64

Retrieve all variables — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response wrapper containing an array of variables returned by the list operation. Additional keys: not allowed
variables	array	Required within parent	Array of variable objects, each containing the variable details such as name, API name, type, value, and variable group. Maximum items: 200
variables[]	Model	Each item	Expand specific variable — response body — variables item

Referenced models: specific variable — response body — variables item

Specific variable — variables delete Variables By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response summarizing outcomes of variable removal within a scoped context, with per-item results. Additional keys: not allowed
variables	array	Optional	Array of operation results for each deleted variable. 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

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

Update variables — request body — body

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

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

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

Update variables — response body

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

Referenced models: Delete variables — response body — variables item

Variable Associations — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response containing an array of variable association groups for the requested context. Additional keys: not allowed
variables_associations	array	Required within parent	Array of variable association groups, each containing the association type and related resources. Maximum items: 1
variables_associations[]	Model	Each item	Expand Variable Associations — response body — variables associations item

Referenced models: Variable Associations — response body — variables associations item

Variable Associations — response body — variables associations item

Field	Type	Presence	Description and constraints
$	object	Root	Grouping of variable associations under a named category, including the list of associated resources. Additional keys: not allowed
name	string	Required within parent	The name of the association category (for example, email_templates). Maximum length: 255
resources	array	Required within parent	Array of resources associated with this variable under this category. Maximum items: 1
resources[]	Model	Each item	Expand Variable Associations — response body — variables associations item resources item

Referenced models: Variable Associations — response body — variables associations item resources item

Variable Associations — response body — variables associations item resources item

Field	Type	Presence	Description and constraints
$	object	Root	A resource associated with variables, including name, id, and nested association details. Additional keys: not allowed
details	Model	Required within parent	Expand Variable Associations — response body — variables associations item resources item details
id	string	Required within parent	The unique ID of the associated resource. Format: int64 Maximum length: 19
name	string	Required within parent	The name of the associated resource. Maximum length: 255

Referenced models: Variable Associations — response body — variables associations item resources item details

Variable Associations — response body — variables associations item resources item details

Field	Type	Presence	Description and constraints
$	object	Root	Details about a resource association, including the referenced module. Additional keys: not allowed
module	Model	Required within parent	Expand Variable Associations — response body — variables associations item resources item details module

Referenced models: Variable Associations — response body — variables associations item resources item details module

Variable Associations — response body — variables associations item resources item details module

Field	Type	Presence	Description and constraints
$	object	Root	Minimal reference to a module used in association details, containing id and apiName. Additional keys: not allowed
api_name	string	Required within parent	The API name of the CRM module. Maximum length: 255
id	string	Required within parent	The unique ID of the CRM module. Format: int64

specific variable — response body

Field	Type	Presence	Description and constraints
$	object	Root	Collection wrapper returning variables associated with the specified group identifier. Additional keys: not allowed
variables	array	Required within parent	Array of variable operation results. Maximum items: 25
variables[]	Model	Each item	Expand specific variable — response body — variables item

Referenced models: specific variable — response body — variables item

specific variable — response body — variables item

Field	Type	Presence	Description and constraints
$	object	Root	Representation of a variable within collection responses, including readOnly, apiName, name, description, id, source, type, value, and group brief. Additional keys: not allowed
api_name	string	Required within parent	The API name of the CRM variable. Maximum length: 100
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	The description of the variable, if any. Maximum length: 3000
description (anyOf 2)	null	Alternative	The description of the variable, if any. Maximum length: 3000
id	string	Required within parent	The unique ID of the variable. Format: int64 Maximum length: 19
name	string	Required within parent	The display name of the variable. Maximum length: 50
read_only	boolean	Optional	Indicates whether the variable is read-only.
source	string	Required within parent	The source of the variable (for example, crm). Maximum length: 255
type	string	Required within parent	The data type of the variable (for example, text, integer, percent, decimal, currency, date, datetime, email, phone, url, checkbox, textarea, long). Maximum length: 255
value	string	Optional	The current value of the variable, if any. Maximum length: 3000
variable_group	Model	Required within parent	Expand specific variable — response body — variables item variable group

Referenced models: specific variable — response body — variables item variable group

specific variable — response body — variables item variable group

Field	Type	Presence	Description and constraints
$	object	Root	Base schema for variable_group Additional keys: allowed
api_name	string	Optional	The API name of the variable group. Maximum length: 100
id	string	Optional	The unique ID of the variable group. Maximum length: 19
name	string	Optional	The display name of the variable group. Maximum length: 50