duplicate check preference api. 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": "Duplicate Check Preference",
"description": "duplicate check preference api",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.duplicate_check_preference.ALL"
]
}
],
"paths": {
"/settings/duplicate_check_preference": {
"get": {
"summary": "Get Duplicate Check Preference",
"description": "Get Duplicate Check Preference",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.duplicate_check_preference.READ"
]
}
],
"operationId": "getDuplicateCheckPreference",
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"responses": {
"200": {
"description": "Successful response with Duplicate Check Preference details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDuplicateCheckPreference",
"x-zs-$id": "GetDuplicateCheckPreference"
}
}
}
},
"204": {
"description": "If feature not enabled for the given module"
}
}
},
"post": {
"summary": "Create Duplicate Check Preference",
"description": "Create Duplicate Check Preference",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.duplicate_check_preference.CREATE"
]
}
],
"operationId": "createDuplicateCheckPreference",
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDuplicateCheckPreference"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful response with Duplicate Check Preference details",
"content": {
"application/json": {
"schema": {
"description": "Response wrapper object containing the duplicate check preference details.",
"additionalProperties": false,
"type": "object",
"properties": {
"duplicate_check_preference": {
"description": "Details of the duplicate check preference configuration.",
"additionalProperties": false,
"type": "object",
"properties": {
"code": {
"description": "Status code indicating the result of the operation.",
"type": "string",
"enum": [
"SUCCESS"
]
},
"status": {
"description": "Status of the operation.",
"type": "string",
"enum": [
"success"
]
},
"message": {
"description": "Human-readable message providing additional information about the operation result.",
"maxLength": 100,
"type": "string"
},
"details": {
"description": "Additional details related to the operation.",
"additionalProperties": false,
"type": "object"
}
}
}
},
"required": [
"duplicate_check_preference"
]
}
}
}
},
"400": {
"description": "Bad Request - Invalid input or missing required parameters",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Request-level error format (returned when request param is fundamentally malformed, e.g., missing 'module' parameter).",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Error status indicator."
},
"code": {
"type": "string",
"enum": [
"REQUIRED_PARAM_MISSING"
],
"description": "Machine-readable error code for request-level failures."
},
"message": {
"type": "string",
"enum": [
"One of the expected parameter is missing."
],
"description": "Human-readable error message."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Contextual error details including field location.",
"properties": {
"param_name": {
"type": "string",
"maxLength": 10,
"description": "param_name that caused the error (e.g., 'module')."
}
},
"required": [
"param_name"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Request-level error format (returned when feature not supported).",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Error status indicator."
},
"code": {
"type": "string",
"enum": [
"FEATURE_NOT_SUPPORTED"
],
"description": "Machine-readable error code for request-level failures."
},
"message": {
"type": "string",
"enum": [
"Your License does not support this feature."
],
"description": "Human-readable error message."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Contextual error details including field location."
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"description": "Request-level error format (returned when feature not supported).",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_SUPPORTED"
],
"description": "Machine-readable error code for request-level failures."
},
"message": {
"type": "string",
"enum": [
"The feature not avilable in the given module."
],
"description": "Human-readable error message."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Contextual error details including field location.",
"properties": {
"param_name": {
"type": "string",
"maxLength": 10,
"description": "param_name that caused the error (e.g., 'module')."
},
"api_name": {
"type": "string",
"maxLength": 10,
"description": "API name of the field with invalid data."
},
"json_path": {
"type": "string",
"maxLength": 100,
"description": "JSONPath to the location of the invalid field."
}
},
"required": [
"param_name",
"api_name",
"json_path"
]
}
},
"required": [
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Request-level error format (returned when feature not supported).",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"ALREADY_CONFIGURED"
],
"description": "Machine-readable error code for request-level failures."
},
"message": {
"type": "string",
"enum": [
"already configured."
],
"description": "Human-readable error message."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Contextual error details including field location."
}
},
"required": [
"code",
"message"
]
},
{
"type": "object",
"description": "AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action).",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating parameter ambiguity.",
"enum": [
"AMBIGUITY_DURING_PROCESSING"
]
},
"details": {
"type": "object",
"description": "Details about the ambiguous parameters.",
"additionalProperties": false,
"properties": {
"ambiguity_due_to": {
"type": "array",
"maxItems": 2,
"description": "Array of conflicting parameters that caused the ambiguity.",
"items": {
"type": "object",
"description": "Parameter that contributed to the ambiguity.",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"maxLength": 10,
"description": "API field name that caused the error (e.g., 'tab_groups')."
},
"json_path": {
"type": "string",
"maxLength": 100,
"description": "JSONPath expression locating the error (e.g., '$.tab_groups')."
}
},
"required": [
"api_name",
"json_path"
]
}
}
},
"required": [
"ambiguity_due_to"
]
},
"message": {
"type": "string",
"description": "Human-readable error message explaining the ambiguity.",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Error status indicator.",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "MANDATORY_NOT_FOUND error when required fields are missing",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating a mandatory field is missing",
"enum": [
"MANDATORY_NOT_FOUND"
]
},
"details": {
"type": "object",
"description": "Error details with field location information",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"maxLength": 50,
"description": "Name of the required field that is missing"
},
"json_path": {
"type": "string",
"description": "JSONPath expression locating where the field should be in the request",
"maxLength": 100
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Human-readable error message describing the missing required field",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "DEPENDENT_FIELD_MISSING error when dependent configuration is missing",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating a dependent field is missing",
"enum": [
"DEPENDENT_FIELD_MISSING"
]
},
"details": {
"type": "object",
"description": "Error details with field location information",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"maxLength": 50,
"description": "Name of the dependent field that is missing"
},
"json_path": {
"type": "string",
"description": "JSONPath expression locating where the field should be in the request",
"maxLength": 100
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Human-readable error message describing the missing dependent field",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "EXPECTED_FIELD_MISSING error for missing expected fields",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code for missing expected field",
"enum": [
"EXPECTED_FIELD_MISSING"
]
},
"details": {
"type": "object",
"description": "Details about missing expected fields",
"additionalProperties": false,
"properties": {
"expected_fields": {
"type": "array",
"maxItems": 10,
"description": "List of fields that were expected but missing",
"items": {
"type": "object",
"description": "Field location details",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"minLength": 1,
"maxLength": 50
},
"json_path": {
"type": "string",
"description": "JSONPath location where field was expected",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"api_name",
"json_path"
]
},
"minItems": 1
}
},
"required": [
"expected_fields"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"minLength": 1,
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Status indicator for error",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "INVALID_DATA error for data validation failures",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating invalid or malformed data",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"description": "Error details with field information",
"additionalProperties": false,
"properties": {
"maximum_length": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed length for the field"
},
"expected_data_type": {
"type": "string",
"maxLength": 50,
"description": "Expected data type for the field"
},
"api_name": {
"type": "string",
"description": "Name of the field with invalid data",
"maxLength": 50
},
"json_path": {
"type": "string",
"description": "JSONPath expression locating the invalid field in the request",
"maxLength": 100
}
}
},
"message": {
"type": "string",
"description": "Human-readable error message describing the invalid data",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "NOT_ALLOWED error for operations that are not permitted",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating operation is not allowed",
"enum": [
"NOT_ALLOWED"
]
},
"details": {
"type": "object",
"description": "Error details with field location information",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "Name of the field or operation that is not allowed",
"maxLength": 50
},
"json_path": {
"type": "string",
"description": "JSONPath expression locating the not-allowed field or operation",
"maxLength": 100
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Human-readable error message explaining what is not allowed",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "NOT_SUPPORTED error for unsupported operations",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code for unsupported operation",
"enum": [
"NOT_SUPPORTED"
]
},
"details": {
"type": "object",
"description": "Additional error details (typically empty)",
"additionalProperties": false,
"properties": {
"param_name": {
"type": "string",
"maxLength": 10,
"description": "param_name that caused the error (e.g., 'module')."
},
"api_name": {
"type": "string",
"description": "Name of the field or operation that is not allowed",
"maxLength": 50
},
"json_path": {
"type": "string",
"description": "JSONPath expression locating the not-allowed field or operation",
"maxLength": 100
}
}
},
"message": {
"type": "string",
"description": "Human-readable error message",
"minLength": 1,
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Status indicator for error",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "ALREADY_CONFIGURED error for unsupported operations",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code for unsupported operation",
"enum": [
"ALREADY_CONFIGURED",
"NO_PERMISSION"
]
},
"details": {
"type": "object",
"description": "Additional error details (typically empty)",
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Human-readable error message",
"minLength": 1,
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Status indicator for error",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-duplicate-check-preference-openapi.json