API specification for variable_groups. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 4 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Variable Groups",
"description": "API specification for variable_groups",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variable_groups.UPDATE",
"ZohoCRM.settings.variable_groups.CREATE",
"ZohoCRM.settings.variable_groups.READ"
]
}
],
"paths": {
"/settings/variable_groups": {
"get": {
"summary": "GET /settings/variable_groups",
"description": "To get the list variable groups created in crm org",
"operationId": "getVariableGroups",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupListResponse"
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionDeniedError"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variable_groups.READ"
]
}
]
},
"put": {
"summary": "PUT variable_groups",
"description": "Update variable group details",
"operationId": "putVariableGroups",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupUpdateRequestAlt"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupCollectionResponse"
}
}
}
},
"207": {
"description": "Multi status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupMultiStatusResponseAlt"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InvalidVariableGroupsTypeError"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variable_groups",
"properties": {
"variable_groups": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DuplicateVariableGroupError"
},
{
"$ref": "#/components/schemas/SystemVariableGroupActionNotAllowedError"
},
{
"$ref": "#/components/schemas/MandatoryFieldIdMissingError"
},
{
"$ref": "#/components/schemas/ApiNamePatternMismatchError"
},
{
"$ref": "#/components/schemas/InvalidVariableGroupIdError"
},
{
"$ref": "#/components/schemas/ProcessingAmbiguityError"
},
{
"$ref": "#/components/schemas/MandatoryFieldMissingError"
},
{
"$ref": "#/components/schemas/InvalidFieldDataTypeError"
},
{
"$ref": "#/components/schemas/InvalidDataError"
}
]
},
"maxItems": 25
}
},
"required": [
"variable_groups"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionDeniedError"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variable_groups.UPDATE"
]
}
]
}
},
"/settings/variable_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "variable groups id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
],
"get": {
"summary": "GET variable_groups by {id}",
"description": "To get the particular variable group",
"operationId": "getVariableGroupById",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupQueryResponse"
}
}
}
},
"204": {
"description": "No Content - Successful response with no body"
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidIdentifierError"
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionDeniedError"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variable_groups.READ"
]
}
]
},
"put": {
"summary": "PUT by variable_groups by id",
"description": "Update variable group details",
"operationId": "putVariableGroupById",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupDefinitionRequestAlt"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableGroupOperationResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InvalidVariableGroupsTypeError"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variable_groups",
"properties": {
"variable_groups": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DuplicateVariableGroupError"
},
{
"$ref": "#/components/schemas/ApiNamePatternMismatchError"
},
{
"$ref": "#/components/schemas/SystemVariableGroupActionNotAllowedError"
},
{
"$ref": "#/components/schemas/InvalidFieldDataTypeError"
},
{
"$ref": "#/components/schemas/InvalidDataError"
}
]
},
"maxItems": 25
}
},
"required": [
"variable_groups"
]
},
{
"$ref": "#/components/schemas/InvalidIdentifierError"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionDeniedError"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variable_groups.UPDATE"
]
}
]
}
}
},
"components": {
"schemas": {
"InvalidVariableGroupIdError": {
"type": "object",
"additionalProperties": false,
"description": "The provided variable group id is invalid. Includes code INVALID_DATA with message, status, and details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"the id given seems to be invalid"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Invalid Variable Group ID Error"
},
"VariableGroupMultiStatusResponseAlt": {
"type": "object",
"additionalProperties": false,
"description": "Alternate multi-status response schema exposing a variable_groups array with per-item operation results.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Field: variable_groups",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/VariableGroupOperationStatus"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1117753881"
}
]
},
"maxItems": 2
}
},
"title": "Variable Group Multi-Status Response (Alternate)"
},
"PermissionDeniedError": {
"type": "object",
"additionalProperties": false,
"description": "The client does not have permission to access variable group settings. Provides the error code NO_PERMISSION, message, status, and details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NO_PERMISSION"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"permissions": {
"type": "array",
"description": "Detail field: permissions",
"items": {
"type": "string",
"description": "Detail Field: permissions",
"maxLength": 255
},
"maxItems": 25
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"permission denied"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Permission Denied Error"
},
"ProcessingAmbiguityError": {
"type": "object",
"additionalProperties": false,
"description": "Ambiguity occurred while processing the request. Returns code AMBIGUITY_DURING_PROCESSING with supporting details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"AMBIGUITY_DURING_PROCESSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"ambiguity_due_to": {
"type": "array",
"description": "Detail field: ambiguity_due_to",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Detail Field: ambiguity_due_to",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
}
},
"maxItems": 25
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Ambiguity while processing the request"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Processing Ambiguity Error"
},
"VariableGroupUpdateRequestAlt": {
"type": "object",
"additionalProperties": false,
"description": "Alternate request wrapper containing a variable_groups array of update items for batch processing.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Root key name (Required)",
"items": {
"$ref": "#/components/schemas/VariableGroupUpdateItemAlt"
},
"maxItems": 10,
"minItems": 1
}
},
"required": [
"variable_groups"
],
"title": "Variable Group Update Request (Alternate)"
},
"InvalidFieldDataTypeError": {
"type": "object",
"additionalProperties": false,
"description": "One or more fields contain values with an invalid data type. Returns code INVALID_DATA with detailed validation information.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Detail field: expected_data_type",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Invalid data type"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Invalid Field Data Type Error"
},
"DuplicateVariableGroupError": {
"type": "object",
"additionalProperties": false,
"description": "Duplicate data detected for one or more variable groups. Includes code DUPLICATE_DATA with supporting details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DUPLICATE_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"duplicate data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Duplicate Variable Group Error"
},
"VariableGroupDefinitionInputAlt": {
"type": "object",
"additionalProperties": false,
"description": "Alternate schema instance for variable group definition with name, description, and api_name.",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "variable group name",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"description": "description of the variable group",
"maxLength": 3000
},
"api_name": {
"type": [
"string",
"null"
],
"description": "variable group api name",
"maxLength": 100
}
},
"title": "Variable Group Definition Input (Alternate)"
},
"VariableGroupCollectionResponse": {
"type": "object",
"additionalProperties": false,
"description": "Successful response containing the current collection of variable groups after processing the request.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Field: variable_groups",
"items": {
"$ref": "#/components/schemas/VariableGroupOperationStatus"
},
"maxItems": 1
}
},
"title": "Variable Group Collection Response"
},
"VariableGroupOperationStatus": {
"type": "object",
"additionalProperties": false,
"description": "Per-item result for a variable group operation, including code, message, status, and contextual details.",
"properties": {
"code": {
"type": "string",
"description": "Field: code",
"maxLength": 255
},
"details": {
"$ref": "#/components/schemas/VariableGroupFieldPathDetails"
},
"message": {
"type": "string",
"description": "Field: message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Field: status",
"maxLength": 255
}
},
"title": "Variable Group Operation Status"
},
"ErrorResponseCore1117753881": {
"type": "object",
"additionalProperties": false,
"description": "duplicate data",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DUPLICATE_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"duplicate data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"VariableGroupOperationResponse": {
"type": "object",
"additionalProperties": false,
"description": "Successful response containing variable_groups with per-item operation statuses for the requested action.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Field: variable_groups",
"items": {
"$ref": "#/components/schemas/VariableGroupOperationStatus"
},
"maxItems": 1
}
},
"title": "Variable Group Operation Response"
},
"InvalidVariableGroupsTypeError": {
"type": "object",
"additionalProperties": false,
"description": "The variable_groups field has an invalid data type. Returns code INVALID_DATA with message, status, and detailed validation info.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"maximum_length": {
"type": "integer",
"format": "int32",
"description": "Detail field: maximum_length"
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"invalid data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Invalid variable_groups Type Error"
},
"VariableGroupUpdateItemAlt": {
"type": "object",
"additionalProperties": false,
"description": "Alternate schema instance for updating a variable group with id (required), rid, name, api_name, and description.",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "variable group name",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"description": "variable group description",
"maxLength": 3000
},
"id": {
"type": "string",
"description": "variable group id (Required)",
"maxLength": 18
},
"rid": {
"type": [
"string",
"null"
],
"description": "variable group rid",
"maxLength": 36
},
"api_name": {
"type": [
"string",
"null"
],
"description": "variable group api name",
"maxLength": 100
}
},
"required": [
"id"
],
"title": "Variable Group Update Item (Alternate)"
},
"VariableGroupQueryResponse": {
"type": "object",
"additionalProperties": false,
"description": "Container for results of a targeted variable group retrieval, exposing a variable_groups array of lookup summaries.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Field: variable_groups",
"items": {
"$ref": "#/components/schemas/VariableGroupSummaryLookup"
},
"maxItems": 1
}
},
"required": [
"variable_groups"
],
"title": "Variable Group Query Response"
},
"ApiNamePatternMismatchError": {
"type": "object",
"additionalProperties": false,
"description": "The api_name value does not comply with the required pattern. Returns code PATTERN_NOT_MATCHED with details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"PATTERN_NOT_MATCHED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Please check whether the input values are correct"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "API Name Pattern Mismatch Error"
},
"VariableGroupDefinitionRequestAlt": {
"type": "object",
"additionalProperties": false,
"description": "Alternate request wrapper containing the variable_groups array for defining or updating variable group metadata.",
"properties": {
"variable_groups": {
"type": "array",
"description": "Root key name (Required)",
"items": {
"$ref": "#/components/schemas/VariableGroupDefinitionInputAlt"
},
"maxItems": 1,
"minItems": 1
}
},
"required": [
"variable_groups"
],
"title": "Variable Group Definition Request (Alternate)"
},
"InvalidDataError": {
"type": "object",
"additionalProperties": false,
"description": "The request contains invalid data. Provides code INVALID_DATA, message, status, and validation details.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"maximum_length": {
"type": "integer",
"format": "int32",
"description": "Detail field: maximum_length"
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-variable-groups-openapi.json