Zoho: Variable groups schemas

← Variable groups operations · All schemas

Generate API Name — variable Groups generate Api Name — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for the generate API name operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array containing a single variable group item submitted for API name generation. Maximum items: 1 Minimum items: 1
variable_groups[]	Model	Each item	Expand Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Referenced models: Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single variable group item submitted for API name generation. Additional keys: not allowed
name	string	Required within parent	Represents the proposed name of the variable group for which an available API name is generated. Maximum length: 50

Generate API Name — variable Groups generate Api Name — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful generate API name operation. Additional keys: not allowed
variable_groups	array	Optional	Represents an array of per-item results containing the generated API names for each submitted variable group. Maximum items: 1
variable_groups[]	Model	Each item	Expand Update variable group by ID — response body — variable groups item

Referenced models: Update variable group by ID — response body — variable groups item

Get variable group by ID — response body — variable groups

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for the get variable group by ID operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array containing the variable group matching the specified ID. Maximum items: 1
variable_groups[]	Model	Each item	Expand Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Referenced models: Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Update variable group by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for updating a variable group by ID. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array containing a single variable group definition item for the update by ID operation. Maximum items: 1 Minimum items: 1
variable_groups[]	Model	Each item	Expand Update variable group by ID — request body — body variable groups item

Referenced models: Update variable group by ID — request body — body variable groups item

Update variable group by ID — request body — body variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single variable group item containing the fields to update when updating a variable group by ID. Additional keys: not allowed
api_name	string or null	Optional	Represents the API name for the variable group. The value must comply with the required naming pattern. This field is nullable. Maximum length: 100
description	string or null	Optional	Represents the description of the variable group. This field is nullable. Maximum length: 3000
name	string or null	Optional	Represents the display name of the variable group. This field is nullable. Maximum length: 50

Update variable group by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful update variable group by ID operation. Additional keys: not allowed
variable_groups	array	Optional	Represents an array containing the per-item operation status for the updated variable group. Maximum items: 1
variable_groups[]	Model	Each item	Expand Update variable group by ID — response body — variable groups item

Referenced models: Update variable group by ID — response body — variable groups item

Update variable group by ID — response body — variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the per-item operation result for a variable group action, including the status code, message, and optional field path details. Additional keys: not allowed
code	string	Optional	Represents the status code for the individual variable group operation result. Maximum length: 255
details	Model	Optional	Expand Update variable group by ID — response body — variable groups item details
message	string	Optional	Represents the message describing the result of the individual variable group operation. Maximum length: 255
status	string	Optional	Represents the status of the individual variable group operation result. Maximum length: 255

Referenced models: Update variable group by ID — response body — variable groups item details

Update variable group by ID — response body — variable groups item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field path details returned in per-item operation results, providing context about which field the result pertains to. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the variable group field that the operation result refers to. Maximum length: 255
id	string	Optional	Represents the unique ID of the variable group field that the operation result refers to. Maximum length: 255

Variable Groups — variable Groups get Variable Groups — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for the list variable groups operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array of variable group summary objects returned in the list response. Maximum items: 100
variable_groups[]	Model	Each item	Expand Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Referenced models: Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Variable Groups — variable Groups get Variable Groups — response body — variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a summary of a variable group returned in list and retrieval responses. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the variable group, used to reference the group in API calls. Maximum length: 100
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Represents the description of the variable group. This field is nullable. Maximum length: 3000
description (anyOf 2)	null	Alternative	Represents the description of the variable group. This field is nullable. Maximum length: 3000
display_label	string	Required within parent	Represents the display label of the variable group shown in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents the unique ID of the variable group. Maximum length: 19
name	string	Required within parent	Represents the internal name of the variable group. Maximum length: 50
source	string	Required within parent	Represents the source of the variable group, indicating whether it is system-defined or user-defined. Maximum length: 255

Variable Groups — variable Groups update Variable Groups — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for the bulk update variable groups operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array of variable group update items for batch processing. The array accepts 1 to 10 items. Maximum items: 10 Minimum items: 1
variable_groups[]	Model	Each item	Expand Variable Groups — variable Groups update Variable Groups — request body — body variable groups item

Referenced models: Variable Groups — variable Groups update Variable Groups — request body — body variable groups item

Variable Groups — variable Groups update Variable Groups — request body — body variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single variable group item for batch update operations. Additional keys: not allowed
api_name	string or null	Optional	Represents the API name to update for the variable group. This field is nullable. Maximum length: 100
description	string or null	Optional	Represents the updated description for the variable group. This field is nullable. Maximum length: 3000
id	string	Required within parent	Represents the unique ID of the variable group to update. Maximum length: 18
name	string or null	Optional	Represents the updated display name for the variable group. This field is nullable. Maximum length: 50

Variable Groups — variable Groups update Variable Groups — response body — variable groups — Variable Group Collection Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful variable group update operation. Additional keys: not allowed
variable_groups	array	Optional	Represents an array of per-item operation status objects returned after processing the update request. Maximum items: 1
variable_groups[]	Model	Each item	Expand Update variable group by ID — response body — variable groups item

Referenced models: Update variable group by ID — response body — variable groups item

Variable Groups — variable Groups update Variable Groups — response body — variable groups — Variable Group Multi Status Response Alt

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-status response body returned when individual variable group items in a bulk update operation have different outcomes. Additional keys: not allowed
variable_groups	array	Optional	Represents an array of per-item results for the bulk update operation, where each item can be a success or an error response. Maximum items: 2
variable_groups[]	JSON	Each item	Represents a single per-item result in the multi-status response for the bulk update operation.
variable_groups[] (anyOf 1)	Model	Alternative	Expand Update variable group by ID — response body — variable groups item
variable_groups[] (anyOf 2)	Model	Alternative	Expand Variable Groups — variableGroups.updateVariableGroups — response body — variable_groups / variable_groups / item / code: DUPLICATE DATA, message: duplicate data, status: error

Referenced models: Variable Groups — variableGroups.updateVariableGroups — response body — variable_groups / variable_groups / item / code: DUPLICATE DATA, message: duplicate data, status: error, Update variable group by ID — response body — variable groups item

Variable Groups — variableGroups.updateVariableGroups — response body — variable_groups / variable_groups / item / code: DUPLICATE DATA, message: duplicate data, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents an error response returned when duplicate data is detected for a variable group item in a multi-status response. Additional keys: not allowed
code	string	Required within parent	Represents the error code **DUPLICATE_DATA**. Known values: DUPLICATE_DATA
details	object	Required within parent	Represents the validation details for the duplicate field. Additional keys: not allowed
details.api_name	string	Optional	Represents the API name of the field that contains the duplicate value. Maximum length: 255
details.json_path	string	Optional	Represents the JSON path of the field that contains the duplicate value. Maximum length: 1000
message	string	Required within parent	Represents the error message indicating that duplicate data was detected. Known values: duplicate data
status	string	Required within parent	Represents the status of the error response. The value is always **error**. Known values: error