Zoho: Fields schemas (part 2)

2 Zoho schemas with complete fields and constraints.

Update custom fields — response body — fields fields item Represents the error response structure

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the error response structure. Additional keys: allowed
`$ (anyOf 1)`	object	Alternative	Represents the error Response for invalid data. Additional keys: not allowed
`$ (anyOf 1).code`	string	Required within parent	Represents the error code identifying the specific type or category of the error returned in the response. Known values: INVALID_DATA
`$ (anyOf 1).details`	JSON	Required within parent
`$ (anyOf 1).details (anyOf 1)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details Represents the error Response for invalid data
`$ (anyOf 1).details (anyOf 2)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details Represents the request has invalid datatype
`$ (anyOf 1).details (anyOf 3)`	object	Alternative	Represents the request has invalid datatype Additional keys: not allowed
`$ (anyOf 1).details (anyOf 3).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 30
`$ (anyOf 1).details (anyOf 3).json_path`	string	Required within parent	Represents the JSON path identifying the exact location of the offending field within the request payload. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 1).details (anyOf 3).range`	object	Required within parent	Represents the name of the expected_data_type. Additional keys: not allowed
`$ (anyOf 1).details (anyOf 3).range.from`	JSON	Optional
`$ (anyOf 1).details (anyOf 3).range.from (anyOf 1)`	integer	Alternative	Represents the start of the expected data type range. Format: int32
`$ (anyOf 1).details (anyOf 3).range.from (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).details (anyOf 3).range.to`	JSON	Optional
`$ (anyOf 1).details (anyOf 3).range.to (anyOf 1)`	integer	Alternative	Represents the end of the expected data type range. Format: int32
`$ (anyOf 1).details (anyOf 3).range.to (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).details (anyOf 4)`	object	Alternative	Represents the in uri the data passed is wrong. Additional keys: not allowed
`$ (anyOf 1).details (anyOf 4).resource_path_index`	JSON	Required within parent
`$ (anyOf 1).details (anyOf 4).resource_path_index (anyOf 1)`	integer	Alternative	Represents the index of the resource path. Format: int32
`$ (anyOf 1).details (anyOf 4).resource_path_index (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).details (anyOf 5)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details api name, json path, supported values
`$ (anyOf 1).details (anyOf 6)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details allowed values, api name, json path
`$ (anyOf 1).details (anyOf 7)`	object	Alternative	Represents the request has invalid datatype Additional keys: not allowed
`$ (anyOf 1).details (anyOf 7).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 1).details (anyOf 7).json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 1).details (anyOf 7).maximum_length`	JSON	Required within parent
`$ (anyOf 1).details (anyOf 7).maximum_length (anyOf 1)`	integer	Alternative	Represents the maximum lenght allowed. Format: int32
`$ (anyOf 1).details (anyOf 7).maximum_length (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).details (anyOf 8)`	object	Alternative	Represents the request has invalid datatype Additional keys: not allowed
`$ (anyOf 1).details (anyOf 8).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 1).details (anyOf 8).json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 1).details (anyOf 8).minimum_length`	JSON	Required within parent
`$ (anyOf 1).details (anyOf 8).minimum_length (anyOf 1)`	integer	Alternative	Represents the minimum length allowed. Format: int32
`$ (anyOf 1).details (anyOf 8).minimum_length (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).details (anyOf 9)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error details api name, expected data type, json path, supported values
`$ (anyOf 1).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 1).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 2)`	object	Alternative	Represents the error response when the given module is invalid. Additional keys: not allowed
`$ (anyOf 2).code`	string	Required within parent	Represents the error code for this error type. Known values: INVALID_MODULE
`$ (anyOf 2).details`	object	Required within parent	Represents the invalid module details. Additional keys: not allowed
`$ (anyOf 2).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 2).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 3)`	object	Alternative	Represents the error response when the given Expression is more length. Additional keys: not allowed
`$ (anyOf 3).code`	string	Required within parent	Represents the error code for this error type. Known values: DYNAMIC_EXPRESSION_LENGTH_EXCEEDED
`$ (anyOf 3).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DYNAMIC EXPRESSION LENGTH EXCEEDED, status: error details
`$ (anyOf 3).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 3).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 4)`	object	Alternative	Represents the error response when a syntax error is error. Additional keys: not allowed
`$ (anyOf 4).code`	string	Required within parent	Represents the error code for this error type. Known values: SYNTAX_ERROR
`$ (anyOf 4).details`	JSON	Required within parent
`$ (anyOf 4).details (anyOf 1)`	object	Alternative	Represents the syntax error details. Additional keys: not allowed
`$ (anyOf 4).details (anyOf 1).api_name`	string	Required within parent	Represents the API name of the field with syntax error. Maximum length: 25
`$ (anyOf 4).details (anyOf 1).json_path`	string	Required within parent	Represents the JSON path of the field with duplicate data. Maximum length: 500
`$ (anyOf 4).details (anyOf 2)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: SYNTAX ERROR, message: Formula expression has syntax error, status: error details Represents the syntax error details
`$ (anyOf 4).message`	string	Required within parent	Represents the error message describing the issue. Known values: Formula expression has syntax error Maximum length: 1000
`$ (anyOf 4).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 5)`	object	Alternative	Represents the error response when a field is already used. Additional keys: not allowed
`$ (anyOf 5).code`	string	Required within parent	Represents the error code for this error type. Known values: ALREADY_USED
`$ (anyOf 5).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: ALREADY USED, status: error, success details
`$ (anyOf 5).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 5).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 6)`	object	Alternative	Represents the error response when a feature is not enabled. Additional keys: not allowed
`$ (anyOf 6).code`	string	Required within parent	Represents the error code for this error type. Known values: FEATURE_NOT_ENABLED
`$ (anyOf 6).details`	object	Required within parent	Represents the details of the feature that is not enabled. Additional keys: not allowed
`$ (anyOf 6).details.api_name`	string	Optional	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 6).details.json_path`	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 6).message`	string	Required within parent	Represents the error message describing the issue. Known values: Duration Configuration enhancement not enabled. Maximum length: 1000
`$ (anyOf 6).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 7)`	object	Alternative	Represents the error response when a feature is not supported. Additional keys: not allowed
`$ (anyOf 7).code`	string	Required within parent	Represents the error code for this error type. Known values: NOT_SUPPORTED
`$ (anyOf 7).details`	object	Required within parent	Represents the details of the feature that is not supported. Additional keys: not allowed
`$ (anyOf 7).details.api_name`	string	Optional	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 7).details.json_path`	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 7).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 7).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 8)`	object	Alternative	Represents the error response when a feature is not supported. Additional keys: not allowed
`$ (anyOf 8).code`	string	Required within parent	Represents the error code for this error type. Known values: FEATURE_NOT_SUPPORTED
`$ (anyOf 8).details`	object	Required within parent	Represents the details of the feature that is not supported. Additional keys: not allowed
`$ (anyOf 8).details.api_name`	string	Optional	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 8).details.json_path`	string	Optional	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 8).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 8).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 9)`	object	Alternative	Represents the error response when a missing braces error occurs. Additional keys: not allowed
`$ (anyOf 9).code`	string	Required within parent	Represents the error code for this error type. Known values: MISSING_BRACES
`$ (anyOf 9).details`	object	Required within parent	Represents the details of the missing braces error. Additional keys: not allowed
`$ (anyOf 9).details.api_name`	string	Required within parent	Represents the API name of the field with missing braces. Known values: expression Maximum length: 26
`$ (anyOf 9).details.json_path`	string	Required within parent	Represents the JSON path of the field with missing braces. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 9).message`	string	Required within parent	Represents the error message describing the issue. Known values: Some of brace is missing in given expression Maximum length: 1000
`$ (anyOf 9).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 10)`	object	Alternative	Represents the error response when an incorrect number of parameters error occurs. Additional keys: not allowed
`$ (anyOf 10).code`	string	Required within parent	Represents the error code for this error type. Known values: INCORRECT_NUMBER_OF_PARAM
`$ (anyOf 10).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INCORRECT NUMBER OF PARAM, message: The number of param is incorrect for one of the method, status: error details
`$ (anyOf 10).message`	string	Required within parent	Represents the error message describing the issue. Known values: The number of param is incorrect for one of the method Maximum length: 1000
`$ (anyOf 10).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 11)`	object	Alternative	Represents the error response when dependent field values do not match. Additional keys: not allowed
`$ (anyOf 11).code`	string	Required within parent	Represents the error code for this error type. Known values: DEPENDENT_MISMATCH
`$ (anyOf 11).details`	JSON	Required within parent
`$ (anyOf 11).details (anyOf 1)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT MISMATCH, status: error, success details Represents the dependent mismatch details — shared_details_c02eb029dee2
`$ (anyOf 11).details (anyOf 2)`	object	Alternative	Represents the dependent mismatch details. Additional keys: not allowed
`$ (anyOf 11).details (anyOf 2).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 11).details (anyOf 2).dependee`	object	Required within parent	Represents the dependice Details . Additional keys: not allowed
`$ (anyOf 11).details (anyOf 2).dependee.api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 11).details (anyOf 2).dependee.json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 11).details (anyOf 2).json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 11).details (anyOf 2).range`	object	Required within parent	Represents the allowed numeric range. Additional keys: not allowed
`$ (anyOf 11).details (anyOf 2).range.from`	JSON	Required within parent
`$ (anyOf 11).details (anyOf 2).range.from (anyOf 1)`	integer	Alternative	Represents the minimum allowed value. Format: int32
`$ (anyOf 11).details (anyOf 2).range.from (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 11).details (anyOf 2).range.to`	JSON	Required within parent
`$ (anyOf 11).details (anyOf 2).range.to (anyOf 1)`	integer	Alternative	Represents the maximum allowed value. Format: int32
`$ (anyOf 11).details (anyOf 2).range.to (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 11).details (anyOf 3)`	object	Alternative	Indicates whether the given data is invalid for a list of values. Additional keys: not allowed
`$ (anyOf 11).details (anyOf 3).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 11).details (anyOf 3).json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 11).details (anyOf 3).supported_values`	array	Required within parent	Represents the list of supported values accepted for the JSON key identified by api_name and json_path. Maximum items: 25 Minimum items: 1
`$ (anyOf 11).details (anyOf 3).supported_values[]`	JSON	Each item
`$ (anyOf 11).details (anyOf 3).supported_values[] (anyOf 1)`	string	Alternative	Represents the values can be present. Maximum length: 255
`$ (anyOf 11).details (anyOf 3).supported_values[] (anyOf 2)`	JSON	Alternative
`$ (anyOf 11).details (anyOf 3).supported_values[] (anyOf 2) (anyOf 1)`	integer	Alternative	Represents the values can be present. Format: int32
`$ (anyOf 11).details (anyOf 3).supported_values[] (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 11).details (anyOf 4)`	Model	Alternative	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT MISMATCH, status: error, success details Represents the dependent mismatch details — shared_details_02ed58aa78cb
`$ (anyOf 11).details (anyOf 5)`	object	Alternative	Represents the maximum length allowed. Additional keys: not allowed
`$ (anyOf 11).details (anyOf 5).api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 11).details (anyOf 5).dependee`	object	Required within parent	Represents the dependice Details . Additional keys: not allowed
`$ (anyOf 11).details (anyOf 5).dependee.api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 11).details (anyOf 5).dependee.json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 11).details (anyOf 5).json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 11).details (anyOf 5).maximum_length`	JSON	Required within parent
`$ (anyOf 11).details (anyOf 5).maximum_length (anyOf 1)`	integer	Alternative	Represents the maximum length allowed. Format: int32
`$ (anyOf 11).details (anyOf 5).maximum_length (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 11).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 11).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 12)`	object	Alternative	Represents the error response when a configured limit is exceeded. Additional keys: not allowed
`$ (anyOf 12).code`	string	Required within parent	Represents the error code for this error type. Known values: LIMIT_EXCEEDED, FIELD_LIMIT_EXCEEDED
`$ (anyOf 12).details`	JSON	Required within parent
`$ (anyOf 12).details (anyOf 1)`	object	Alternative	Represents the limit exceeded details. Additional keys: not allowed
`$ (anyOf 12).details (anyOf 1).limit`	JSON	Optional
`$ (anyOf 12).details (anyOf 1).limit (anyOf 1)`	integer	Alternative	Represents the maximum allowed limit. Format: int32
`$ (anyOf 12).details (anyOf 1).limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 12).details (anyOf 1).limit_due_to`	array	Optional	Represents the fields due to which the limit is exceeded. Maximum items: 25 Minimum items: 1
`$ (anyOf 12).details (anyOf 1).limit_due_to[]`	object	Each item	Represents the field responsible for limit exceed. Additional keys: not allowed
`$ (anyOf 12).details (anyOf 1).limit_due_to[].api_name`	string	Required within parent	Represents the API name of the field. Maximum length: 25
`$ (anyOf 12).details (anyOf 1).limit_due_to[].json_path`	string	Required within parent	Represents the JSON path of the field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 12).details (anyOf 2)`	object	Alternative	Represents the limit exceeded details. Additional keys: not allowed
`$ (anyOf 12).details (anyOf 2).limit`	JSON	Optional
`$ (anyOf 12).details (anyOf 2).limit (anyOf 1)`	integer	Alternative	Represents the maximum allowed limit. Format: int32
`$ (anyOf 12).details (anyOf 2).limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 12).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 12).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 13)`	object	Alternative	Represents the error response when a dependent field is missing. Additional keys: not allowed
`$ (anyOf 13).code`	string	Required within parent	Represents the error code for this error type. Known values: DEPENDENT_FIELD_MISSING
`$ (anyOf 13).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: DEPENDENT FIELD MISSING, status: error, success details
`$ (anyOf 13).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 13).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 14)`	object	Alternative	Represents the error response when expected fields are missing in the request. Additional keys: not allowed
`$ (anyOf 14).code`	string	Required within parent	Represents the error code for this error type. Known values: EXPECTED_FIELD_MISSING
`$ (anyOf 14).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: EXPECTED FIELD MISSING, status: error, success details
`$ (anyOf 14).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 14).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 15)`	object	Alternative	Represents the error response when ambiguity occurs during request processing. Additional keys: not allowed
`$ (anyOf 15).code`	string	Required within parent	Represents the error code for this error type. Known values: AMBIGUITY_DURING_PROCESSING
`$ (anyOf 15).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: AMBIGUITY DURING PROCESSING, status: error, success details
`$ (anyOf 15).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 15).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 16)`	object	Alternative	Represents the error response when expected dependent fields are missing. Additional keys: not allowed
`$ (anyOf 16).code`	string	Required within parent	Represents the error code for this error type. Known values: EXPECTED_DEPENDENT_FIELD_MISSING
`$ (anyOf 16).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: EXPECTED DEPENDENT FIELD MISSING, status: error, success details
`$ (anyOf 16).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 16).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 17)`	object	Alternative	Represents the error response when duplicate data is found. Additional keys: not allowed
`$ (anyOf 17).code`	string	Required within parent	Represents the error code for this error type. Known values: DUPLICATE_DATA
`$ (anyOf 17).details`	object	Required within parent	Represents the duplicate data details. Additional keys: not allowed
`$ (anyOf 17).details.api_name`	string	Optional	Represents the API name of the field with duplicate data. Maximum length: 25
`$ (anyOf 17).details.json_path`	string	Optional	Represents the JSON path of the field with duplicate data. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 17).message`	string	Required within parent	Represents the error message describing the issue. Known values: Duplicate option display_value, Linking Module label is already Exist., duplicate data, API NAME DUPLICATE, Field label duplicate, Duplicate related list name Maximum length: 1000
`$ (anyOf 17).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 18)`	object	Alternative	Represents the error response when a mandatory field is not found in the request. Additional keys: not allowed
`$ (anyOf 18).code`	string	Required within parent	Represents the error code for this error type. Known values: MANDATORY_NOT_FOUND
`$ (anyOf 18).details`	object	Required within parent	Represents the details of the mandatory field that is missing. Additional keys: not allowed
`$ (anyOf 18).details.api_name`	string	Required within parent	Represents the API name of the mandatory field. Maximum length: 25
`$ (anyOf 18).details.json_path`	string	Required within parent	Represents the JSON path of the mandatory field. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 18).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 18).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 19)`	object	Alternative	Represents the error response when a reserved system keyword is used. Additional keys: not allowed
`$ (anyOf 19).code`	string	Required within parent	Represents the error code for this error type. Known values: RESERVED_KEYWORD_NOT_ALLOWED
`$ (anyOf 19).details`	object	Required within parent	Represents the details of the field containing a reserved keyword. Additional keys: not allowed
`$ (anyOf 19).details.api_name`	string	Required within parent	Represents the API name of the field with reserved keyword. Maximum length: 25
`$ (anyOf 19).details.json_path`	string	Required within parent	Represents the JSON path of the field with reserved keyword. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 19).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 19).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 20)`	object	Alternative	Represents the error response when the requested operation or field is not allowed. Additional keys: not allowed
`$ (anyOf 20).code`	string	Required within parent	Represents the error code for this error type. Known values: NOT_ALLOWED
`$ (anyOf 20).details`	JSON	Required within parent
`$ (anyOf 20).details (anyOf 1)`	object	Alternative	Represents the details of why the operation is not allowed. Additional keys: not allowed
`$ (anyOf 20).details (anyOf 1).api_name`	string	Required within parent	Represents the API name of the field or operation. Maximum length: 25
`$ (anyOf 20).details (anyOf 1).json_path`	string	Required within parent	Represents the JSON path of the field or operation. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 20).details (anyOf 2)`	object	Alternative	Represents the details of why the operation is not allowed. Additional keys: not allowed
`$ (anyOf 20).details (anyOf 2).api_name`	string	Required within parent	Represents the API name of the field or operation. Maximum length: 25
`$ (anyOf 20).details (anyOf 2).json_path`	string	Required within parent	Represents the JSON path of the field or operation. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 20).details (anyOf 2).limit`	JSON	Required within parent
`$ (anyOf 20).details (anyOf 2).limit (anyOf 1)`	integer	Alternative	Represents the limit of the field or operation. Format: int32
`$ (anyOf 20).details (anyOf 2).limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 20).details (anyOf 3)`	object	Alternative	Represents the details of why the operation is not allowed. Additional keys: not allowed
`$ (anyOf 20).details (anyOf 3).api_name`	string	Required within parent	Represents the API name of the field or operation. Maximum length: 25
`$ (anyOf 20).details (anyOf 3).id`	string	Required within parent	Represents the ID of the field or operation. Maximum length: 25
`$ (anyOf 20).details (anyOf 3).json_path`	string	Required within parent	Represents the JSON path of the field or operation. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 20).details (anyOf 3).limit`	JSON	Required within parent
`$ (anyOf 20).details (anyOf 3).limit (anyOf 1)`	integer	Alternative	Represents the limit of the field or operation. Format: int32
`$ (anyOf 20).details (anyOf 3).limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 20).details (anyOf 4)`	object	Alternative	Represents the details of why the operation is not allowed. Additional keys: not allowed
`$ (anyOf 20).details (anyOf 4).resource_path_index`	JSON	Required within parent
`$ (anyOf 20).details (anyOf 4).resource_path_index (anyOf 1)`	integer	Alternative	Represents the index of the resource path. Format: int32
`$ (anyOf 20).details (anyOf 4).resource_path_index (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 20).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 20).status`	string	Required within parent	Represents the response status. Known values: error
`$ (anyOf 21)`	object	Alternative	Represents the error response when one of the required parameters is missing. Additional keys: not allowed
`$ (anyOf 21).code`	string	Required within parent	Represents the error code for this error type. Known values: REQUIRED_PARAM_MISSING
`$ (anyOf 21).details`	object	Required within parent	Represents the details of the missing required parameter. Additional keys: not allowed
`$ (anyOf 21).details.param_name`	string	Optional	Represents the name of the missing request parameter. Maximum length: 50
`$ (anyOf 21).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 21).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 22)`	object	Alternative	Represents an error response indicating that the crypt property cannot be changed while the encryption/decryption scheduler is running. Additional keys: not allowed
`$ (anyOf 22).code`	string	Required within parent	Represents the error code for this error type. Known values: PROPERTY_LOCKED
`$ (anyOf 22).details`	object	Required within parent	Represents the error Response for invalid data. Additional keys: not allowed
`$ (anyOf 22).details.api_name`	string	Required within parent	Represents the API name of the global picklist. Maximum length: 25
`$ (anyOf 22).details.json_path`	string	Required within parent	Represents the JSON path to the field with the error. Maximum length: 500 Pattern: ^\$(\.[a-zA-Z_][a-zA-Z0-9_]*\|\[[0-9]+\])+$
`$ (anyOf 22).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 22).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 23)`	object	Alternative	Represents an error response indicating that the crypt property cannot be changed because unsupported criteria were used. Additional keys: not allowed
`$ (anyOf 23).code`	string	Required within parent	Represents the error code for this error type. Known values: INVALID_DATA
`$ (anyOf 23).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: INVALID DATA, status: error, success details
`$ (anyOf 23).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 23).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 24)`	Model	Alternative	Expand Update custom fields — response body — fields fields item Represents the error response structure code NO PERMISSION, status error
`$ (anyOf 25)`	object	Alternative	Represents the error response when one of the required parameters is missing. Additional keys: not allowed
`$ (anyOf 25).code`	string	Required within parent	Represents the error code for this error type. Known values: INVALID_REQUEST_METHOD, OAUTH_SCOPE_MISMATCH, AUTHENTICATION_FAILURE, INVALID_URL_PATTERN, INTERNAL_ERROR
`$ (anyOf 25).details`	object	Required within parent	Represents the additional error details. Additional keys: allowed
`$ (anyOf 25).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`$ (anyOf 25).status`	string	Required within parent	Represents the response status. Known values: error, success
`$ (anyOf 26)`	object	Alternative	Represents the error response when validation of the request body fails. Additional keys: not allowed
`$ (anyOf 26).code`	string	Optional	Represents the error code for this error type. Known values: INCORRECT_DATA_TYPE_PARAM
`$ (anyOf 26).details`	object	Optional	Represents the details of the validation errors. Additional keys: not allowed
`$ (anyOf 26).details.api_name`	string	Optional	Represents the API name of the field with incorrect data type. Maximum length: 25
`$ (anyOf 26).details.json_path`	string	Optional	Represents the JSON path of the field with incorrect data type. Maximum length: 500
`$ (anyOf 26).message`	string	Optional	Represents the error message describing the issue. Maximum length: 255
`$ (anyOf 26).status`	string	Optional	Represents the response status. Must equal: error
`$ (anyOf 27)`	object	Alternative	Represents the error response when validation of the request body fails. Additional keys: not allowed
`$ (anyOf 27).code`	string	Required within parent	Represents the error code for this error type. Known values: PARTICIPATING_FIELD_NOT_FOUND
`$ (anyOf 27).details`	Model	Required within parent	Expand Update custom fields — response body — fields / fields / item / Represents the error response structure / code: PARTICIPATING FIELD NOT FOUND, status error details
`$ (anyOf 27).message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 255
`$ (anyOf 27).status`	string	Required within parent	Represents the response status. Must equal: error

Update custom fields — response body — fields fields item Represents the error response structure code NO PERMISSION, status error

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the error response when the user does not have permission to perform the requested operation. Additional keys: not allowed
`code`	string	Optional	Represents the error code for this error type. Must equal: NO_PERMISSION
`details`	object	Optional	Represents the details of the permissions required to perform the operation. Additional keys: not allowed
`details.permissions`	array	Required within parent	Represents the list of permissions required to perform the operation. Maximum items: 25 Minimum items: 1
`details.permissions[]`	string	Each item	Represents the permission required to perform the operation. Maximum length: 100
`message`	string	Optional	Represents the error message describing the issue. Maximum length: 1000
`status`	string	Optional	Represents the response status. Must equal: error

Report an issue with this page