API specification for Variables_OAS_v8. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 7 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Variables",
"description": "API specification for Variables_OAS_v8",
"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.variables.READ",
"ZohoCRM.settings.variables.CREATE",
"ZohoCRM.settings.variables.UPDATE",
"ZohoCRM.settings.variables.DELETE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.ALL"
]
}
],
"paths": {
"/settings/variables": {
"get": {
"summary": "GET /settings/variables",
"description": "This helps in fetching all the variables",
"operationId": "getVariables",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesListResponse"
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesPermissionDeniedError"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/variables",
"description": "Updates all variables",
"operationId": "putVariables",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchUpdateRequestAlt1"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchUpdateResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"$ref": "#/components/schemas/VariablesInvalidTypeError"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variables",
"properties": {
"variables": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/VariableValueInvalidDataError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataTypeError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataError"
},
{
"$ref": "#/components/schemas/VariableGroupAmbiguityError"
},
{
"$ref": "#/components/schemas/VariablesDuplicateDataExtendedError"
},
{
"$ref": "#/components/schemas/VariableGroupInvalidReferenceError"
}
]
},
"maxItems": 25
}
},
"required": [
"variables"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.UPDATE"
]
}
]
},
"post": {
"summary": "POST /settings/variables",
"description": "this creates variables.",
"operationId": "postVariables",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchInput"
}
}
}
},
"responses": {
"201": {
"description": "Created - Resource created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchOperationCreated"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchOperationMultiStatus"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variables",
"properties": {
"variables": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/VariablesRequestBodyMissingError"
},
{
"$ref": "#/components/schemas/VariablesRequiredFieldMissingError"
},
{
"$ref": "#/components/schemas/VariablesDuplicateDataError"
},
{
"$ref": "#/components/schemas/VariablesDuplicateDataExtendedError"
},
{
"$ref": "#/components/schemas/VariablesMandatoryFieldMissingError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataTypeError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataGenericError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataGeneralError"
},
{
"$ref": "#/components/schemas/VariableGroupInvalidReferenceError"
},
{
"$ref": "#/components/schemas/VariableGroupAmbiguityError"
},
{
"$ref": "#/components/schemas/VariableValueInvalidDataError"
}
]
},
"maxItems": 25
}
},
"required": [
"variables"
]
},
{
"$ref": "#/components/schemas/VariablesInvalidTypeError"
},
{
"description": "Error response for limit exceeded",
"type": "object",
"additionalProperties": false,
"properties": {
"variables": {
"description": "Array of error details",
"type": "array",
"maxItems": 1,
"items": {
"description": "Individual error object",
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"description": "Status of the operation",
"type": "string",
"enum": [
"error"
]
},
"code": {
"description": "Error code",
"type": "string",
"enum": [
"LIMIT_EXCEEDED"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
}
},
"required": [
"variables"
]
},
{
"description": "Error response for limit exceeded",
"type": "object",
"additionalProperties": false,
"properties": {
"variables": {
"description": "Array of error details",
"type": "array",
"maxItems": 1,
"items": {
"description": "Individual error object",
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"description": "Status of the operation",
"type": "string",
"enum": [
"error"
]
},
"code": {
"description": "Error code",
"type": "string",
"enum": [
"NOT_ALLOWED"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {
"api_name": {
"description": "Name of the not allowed parameter",
"type": "string",
"maxLength": 100
},
"json_path": {
"description": "JSON path of the not allowed parameter",
"type": "string",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
}
},
"required": [
"variables"
]
},
{
"description": "Error response for pattern not matched",
"type": "object",
"additionalProperties": false,
"properties": {
"variables": {
"description": "Array of error details",
"type": "array",
"maxItems": 1,
"items": {
"description": "Individual error object",
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"description": "Status of the operation",
"type": "string",
"enum": [
"error"
]
},
"code": {
"description": "Error code",
"type": "string",
"enum": [
"PATTERN_NOT_MATCHED"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {
"api_name": {
"description": "Name of the not allowed parameter",
"type": "string",
"maxLength": 100
},
"json_path": {
"description": "JSON path of the not allowed parameter",
"type": "string",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
}
},
"required": [
"variables"
]
},
{
"description": "Error response for required parameter missing",
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code",
"type": "string",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {
"api_name": {
"description": "Name of the missing required parameter",
"type": "string",
"maxLength": 100
}
},
"required": [
"api_name"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"status": {
"description": "Error status",
"type": "string",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.CREATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/variables",
"description": "Delete all",
"operationId": "deleteVariables",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
},
{
"$ref": "#/components/parameters/ParamQueryRids"
}
],
"responses": {
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesBatchRemovalMultiStatusResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"$ref": "#/components/schemas/VariablesInvalidTypeError"
},
{
"$ref": "#/components/schemas/VariableRidInvalidParameterError"
},
{
"description": "Error response for required parameter missing",
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code",
"type": "string",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {
"param_name": {
"description": "Param name",
"type": "string",
"maxLength": 255
}
},
"required": [
"param_name"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"status": {
"description": "Error status",
"type": "string",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"description": "Error response for variable deletion failures",
"type": "object",
"additionalProperties": false,
"properties": {
"variables": {
"description": "Array of error details",
"type": "array",
"maxItems": 1,
"items": {
"description": "Individual error object",
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"description": "Status of the operation",
"type": "string",
"enum": [
"error"
]
},
"code": {
"description": "Error code",
"type": "string",
"enum": [
"INVALID_DATA"
]
},
"message": {
"description": "Human readable error message",
"type": "string",
"maxLength": 500
},
"details": {
"description": "Additional error details",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "id",
"type": "string",
"maxLength": 200
}
},
"required": [
"id"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
}
},
"required": [
"variables"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.DELETE"
]
}
]
}
},
"/settings/variables/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "variables id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
],
"get": {
"summary": "GET /settings/variables/1234567890",
"description": "Get Variables by ID",
"operationId": "getVariableById",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryGroup"
},
{
"$ref": "#/components/parameters/ParamQueryGroupRid"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesbyGroupResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"$ref": "#/components/schemas/VariableGroupInvalidIDError"
},
{
"$ref": "#/components/schemas/InvalidUrlPatternError"
},
{
"$ref": "#/components/schemas/InvalidResourceIdError"
},
{
"$ref": "#/components/schemas/VariableGroupQueryAmbiguityError"
},
{
"$ref": "#/components/schemas/VariableGroupInvalidRidQueryError"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/variables/1234567890",
"description": "updates variables based on id",
"operationId": "putVariableById",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesScopedBatchUpdateRequestAlt1"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesScopedBatchUpdateResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"$ref": "#/components/schemas/VariablesDomainNotSupportedError"
},
{
"$ref": "#/components/schemas/VariablesInvalidTypeError"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variables",
"properties": {
"variables": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/VariablesDuplicateDataExtendedError"
},
{
"$ref": "#/components/schemas/VariableValueInvalidDataError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataTypeError"
},
{
"$ref": "#/components/schemas/VariablesInvalidDataError"
}
]
},
"maxItems": 25
}
},
"required": [
"variables"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.variables.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/variables/1234567890",
"description": "used to delete particular variables",
"operationId": "deleteVariableById",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariablesScopedRemovalResponse"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for invalid request",
"oneOf": [
{
"$ref": "#/components/schemas/InvalidResourceIdError"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with variables",
"properties": {
"variables": {
"type": "array",
"description": "Array of error objects",
"items": {
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-variables-openapi.json