Zoho: Custom views schemas

← Custom views operations · All schemas

Custom View creation — request body — body custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for creating a Custom View, including its name, filter criteria, field list, sort configuration, and access control settings. Additional keys: not allowed
access_type	string	Required within parent	Represents the access type for the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator. One of: shared, public, only_to_me
category	string	Optional	Represents the category for the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user. One of: public_views, other_users_views, shared_with_me, created_by_me
criteria	Model	Optional	Expand Custom Views — request body — body custom views item criteria
cross_filters	Model	Optional	Expand Custom Views — request body — body custom views item cross filters
favorite	null or integer	Optional	Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
fields	Model	Required within parent	Expand Custom Views — request body — body custom views item fields
locked	boolean	Optional	Indicates whether the Custom View is locked. Possible values: **true** - The view is locked. **false** - The view is not locked.
name	string	Required within parent	Represents the name of the Custom View. Maximum length: 50
shared_to	Model	Optional	Expand Custom Views — request body — body custom views item shared to
sort_by	JSON	Optional	Represents the field used to sort the records in the Custom View.
sort_by (anyOf 1)	Model	Alternative	Expand Sort Order — request body — body custom views item sort by
sort_by (anyOf 2)	null	Alternative	No sort is applied
sort_order	JSON	Optional	Represents the sort order applied to the records in the Custom View.
sort_order (anyOf 1)	string	Alternative	Represents the sort order for the Custom View. Possible values: **asc** - Ascending order. **desc** - Descending order. One of: asc, desc
sort_order (anyOf 2)	null	Alternative	Represents no sort order applied to the Custom View.
wrap_text	boolean	Optional	Indicates whether text wrapping is enabled for the Custom View. Possible values: **true** - Text wrapping is enabled. **false** - Text wrapping is disabled.

Referenced models: Custom Views — request body — body custom views item criteria, Custom Views — request body — body custom views item cross filters, Custom Views — request body — body custom views item fields, Sort Order — request body — body custom views item sort by, Custom Views — request body — body custom views item shared to

Custom View creation — response body — custom views custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful creation response for a Custom View, including the status, code, message, and ID details. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the create operation. Possible values: **SUCCESS** - The Custom View creation completed successfully. Known values: SUCCESS
details	Model	Required within parent	Expand Custom View creation — response body — custom views custom views item details
message	string	Required within parent	Represents the success message for the create operation. Maximum length: 255
status	string	Required within parent	Represents the status of the create response. Possible values: **success** - The operation was successful. Known values: success

Referenced models: Custom View creation — response body — custom views custom views item details

Custom View creation — response body — custom views custom views item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the ID details for a created or affected resource. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the created or affected resource. Format: int64 Maximum length: 25

Custom View creation — response body — custom views custom views item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the creation failure details for a Custom View, containing the error code, status, message, and additional context.
$ (anyOf 1)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data For Update CV
$ (anyOf 2)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error
$ (anyOf 3)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DUPLICATE DATA, status: error
$ (anyOf 4)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed For Update CVBy Id
$ (anyOf 5)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATAS, message: Special Characters are not allowed, status: error
$ (anyOf 6)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Index Fav
$ (anyOf 7)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Id Fav
$ (anyOf 8)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed Details Update
$ (anyOf 9)	Model	Alternative	Expand CustomView creation — response body — custom_views / custom_views / item / value / code: LIMIT EXCEEDED, status: error
$ (anyOf 10)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error
$ (anyOf 11)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Comparator Mismatch
$ (anyOf 12)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Value Mismatch
$ (anyOf 13)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Comparator Value Mismatch
$ (anyOf 14)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Comparator
$ (anyOf 15)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: LOOKUP LIMIT EXCEEDED, status: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Comparator Value Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: DUPLICATE DATA, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Comparator Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Value Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Comparator, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data For Update CV, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Id Fav, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Index Fav, CustomView creation — response body — custom_views / custom_views / item / value / code: LIMIT EXCEEDED, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: LOOKUP LIMIT EXCEEDED, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed Details Update, Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed For Update CVBy Id, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATAS, message: Special Characters are not allowed, status: error

Custom View update — request body — body custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for updating a Custom View by its ID, including the fields to update. Additional keys: not allowed
access_type	string	Optional	Represents the access type for the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator. One of: shared, public, only_to_me
category	string	Optional	Represents the category for the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user. One of: public_views, other_users_views, shared_with_me, created_by_me
criteria	Model	Optional	Expand Custom Views — request body — body custom views item criteria
cross_filters	Model	Optional	Expand Custom Views — request body — body custom views item cross filters
favorite	null or integer	Optional	Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
fields	Model	Optional	Expand Custom Views — request body — body custom views item fields
locked	boolean	Optional	Indicates whether the Custom View is locked. Possible values: **true** - The view is locked. **false** - The view is not locked.
name	string	Optional	Represents the name of the Custom View. Maximum length: 50
shared_to	Model	Optional	Expand Custom Views — request body — body custom views item shared to
sort_by	JSON	Optional	Represents the field used to sort the records in the Custom View.
sort_by (anyOf 1)	Model	Alternative	Expand Sort Order — request body — body custom views item sort by
sort_by (anyOf 2)	null	Alternative	No sort is applied
sort_order	JSON	Optional	Represents the sort order applied to the records in the Custom View.
sort_order (anyOf 1)	string	Alternative	Represents the sort order for the Custom View. Possible values: **asc** - Ascending order. **desc** - Descending order. One of: asc, desc
sort_order (anyOf 2)	null	Alternative	Represents no sort order applied to the Custom View.

Referenced models: Custom Views — request body — body custom views item criteria, Custom Views — request body — body custom views item cross filters, Custom Views — request body — body custom views item fields, Sort Order — request body — body custom views item sort by, Custom Views — request body — body custom views item shared to

Custom Views — request body — body custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for updating a Custom View in a bulk operation, including the view ID and the fields to update. Additional keys: not allowed
access_type	string	Optional	Represents the access type for the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator. One of: shared, public, only_to_me
category	string	Optional	Represents the category for the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user. One of: public_views, other_users_views, shared_with_me, created_by_me
criteria	Model	Optional	Expand Custom Views — request body — body custom views item criteria
cross_filters	Model	Optional	Expand Custom Views — request body — body custom views item cross filters
favorite	null or integer	Optional	Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
fields	Model	Optional	Expand Custom Views — request body — body custom views item fields
id	string	Required within parent	Represents the unique ID of the Custom View to update. Format: int64 Maximum length: 25
locked	boolean	Optional	Indicates whether the Custom View is locked. Possible values: **true** - The view is locked. **false** - The view is not locked.
name	string	Optional	Represents the name of the Custom View. Maximum length: 50
shared_to	Model	Optional	Expand Custom Views — request body — body custom views item shared to
sort_by	JSON	Optional	Represents the field used to sort the records in the Custom View.
sort_by (anyOf 1)	Model	Alternative	Expand Sort Order — request body — body custom views item sort by
sort_by (anyOf 2)	null	Alternative	No sort is applied
sort_order	JSON	Optional	Represents the sort order applied to the records in the Custom View.
sort_order (anyOf 1)	string	Alternative	Represents the sort order for the Custom View. Possible values: **asc** - Ascending order. **desc** - Descending order. One of: asc, desc
sort_order (anyOf 2)	null	Alternative	Represents no sort order applied to the Custom View.

Referenced models: Custom Views — request body — body custom views item criteria, Custom Views — request body — body custom views item cross filters, Custom Views — request body — body custom views item fields, Sort Order — request body — body custom views item sort by, Custom Views — request body — body custom views item shared to

Custom Views — request body — body custom views item criteria

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Related Records — request body — query filters
$ (anyOf 2)	null	Alternative	No criteria applied - the custom view returns all records

Referenced models: Related Records — request body — query filters

Custom Views — request body — body custom views item cross filters

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the cross-filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Get records from a specified module — request body — query cross filters
$ (anyOf 2)	null	Alternative	No cross-filter criteria applied

Referenced models: Get records from a specified module — request body — query cross filters

Custom Views — request body — body custom views item fields

Field	Type	Presence	Description and constraints
$	array	Root	Represents the list of fields included in the Custom View, each with display and pin configuration details. Maximum items: 250
$[]	object	Each item	Represents a field included in the Custom View, with configuration details such as pin status, pin order, and display width. Additional keys: not allowed
$[]._pin	boolean	Optional	Indicates whether the field is pinned in the Custom View. Possible values: **true** - The field is pinned. **false** - The field is not pinned.
$[]._pin_order	integer	Optional	Represents the order of the pinned field within the Custom View. Format: int32
$[]._width	integer	Optional	Represents the display width of the field in pixels. Format: int32
$[].api_name	string or null	Optional	Represents the API name of the field included in the Custom View. Maximum length: 255
$[].id	string or null	Optional	Represents the unique ID of the field included in the Custom View. Format: int64 Maximum length: 25

Custom Views — request body — body custom views item shared to

Field	Type	Presence	Description and constraints
$	array or null	Root	Represents the list of users, roles, groups, or territories the Custom View is shared with. Maximum items: 250
$[]	object	Each item	Shared To Object Additional keys: not allowed
$[].id	string	Required within parent	ID of the user/group Format: int64 Maximum length: 25
$[].name	string	Optional	Name of the user/group Maximum length: 255
$[].subordinates	boolean or null	Optional	Specify true if subordinates are included, false otherwise
$[].type	string	Required within parent	Represents the type of the shared-to entity. Possible values: **territories** - The view is shared with a territory. **roles** - The view is shared with a role. **groups** - The view is shared with a group. **users** - The view is shared with a specific user. One of: territories, roles, groups, users

Custom Views — response body — custom views custom views item custom views

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response containing Custom View wrap failure details. Additional keys: not allowed
custom_views	array	Required within parent	Represents the list of Custom View wrap failure items. Maximum items: 200
custom_views[]	Model	Each item	Expand Custom Views — response body — custom views custom views item custom views custom views item

Referenced models: Custom Views — response body — custom views custom views item custom views custom views item

Custom Views — response body — custom views custom views item custom views custom views item

Field	Type	Presence	Description and constraints
$	JSON	Root	Custom view failure item
$[]	Model	Each item	Expand Custom Views — response body — custom views custom views item custom views custom views item item

Referenced models: Custom Views — response body — custom views custom views item custom views custom views item item

Custom Views — response body — custom views custom views item custom views custom views item item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the value provided for the wrap text configuration is not a valid data type. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid wrap data type error. Possible values: **INVALID_DATA** - The value provided for the wrap text configuration is not a valid data type. Known values: INVALID_DATA
details	JSON	Required within parent	Represents the additional details about the invalid wrap data type error.
details (allOf 1)	Model	All variants apply	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path
message	string	Required within parent	Represents the error message describing the invalid wrap data type. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path

Custom Views — response body — custom views custom views item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the update failure details for a Custom View, containing the error code, status, message, and additional context.
$ (anyOf 1)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data For Update CV
$ (anyOf 2)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error
$ (anyOf 3)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DUPLICATE DATA, status: error
$ (anyOf 4)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed For Update CVBy Id
$ (anyOf 5)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATAS, message: Special Characters are not allowed, status: error
$ (anyOf 6)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Index Fav
$ (anyOf 7)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Id Fav
$ (anyOf 8)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed Details Update
$ (anyOf 9)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data Type
$ (anyOf 10)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error
$ (anyOf 11)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Comparator Mismatch
$ (anyOf 12)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Value Mismatch
$ (anyOf 13)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Comparator Value Mismatch
$ (anyOf 14)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Comparator
$ (anyOf 15)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: LOOKUP LIMIT EXCEEDED, status: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Comparator Value Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: DUPLICATE DATA, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Comparator Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Value Mismatch, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Comparator, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data For Update CV, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data Type, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Id Fav, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Index Fav, Custom Views — response body — custom_views / custom_views / item / value / code: LOOKUP LIMIT EXCEEDED, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error, Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed Details Update, Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed For Update CVBy Id, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATAS, message: Special Characters are not allowed, status: error

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when a criterion comparator cannot be applied because the comparator value supplied by the dependee field is absent. Carries error code DEPENDENT_FIELD_MISSING along with details identifying both the field in error and the dependee field whose value is missing. Additional keys: not allowed
code	string	Required within parent	Represents the error code that identifies the category of failure for this error response. Possible values: DEPENDENT_FIELD_MISSING - Indicates that the comparator value required from the dependee criterion field is absent, preventing the comparator from being evaluated. Known values: DEPENDENT_FIELD_MISSING
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details
message	string	Required within parent	Error message describing the DEPENDENT_FIELD_MISSING condition returned in the response envelope. Maximum length: 512
status	string	Required within parent	Status of the response. Possible values: error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Contains detailed information about the criterion field that caused the error and the dependee field whose comparator value is missing, including the API name and JSON path for each. Additional keys: not allowed
api_name	string	Required within parent	API name of the criterion field that triggered the DEPENDENT_FIELD_MISSING error. Maximum length: 256
dependee	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details dependee
json_path	string	Required within parent	JSON path locating the criterion field in error within the request body. Maximum length: 512

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details dependee

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT FIELD MISSING, status: error details dependee

Field	Type	Presence	Description and constraints
$	object	Root	Represents the dependee criterion field — that is, the field whose value determines what the current comparator accepts — and whose missing comparator value triggered this error. Contains the API name and JSON path of that dependee field. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the dependee criterion field whose comparator value is absent and caused the evaluation failure. Maximum length: 256
json_path	string	Required within parent	Represents the JSON path that locates the dependee criterion field within the request body, identifying where the missing comparator value was expected. Maximum length: 512

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_376507a1648c

Field	Type	Presence	Description and constraints
$	object	Root	The dependee field whose value determines which comparator values are valid for the criterion field that raised the DEPENDENT_MISMATCH error. Contains the API name and JSON path of the dependee field. Additional keys: not allowed
api_name	string	Required within parent	API name of the dependee field that determines the valid comparator values for the criterion field in error. Maximum length: 256
json_path	string	Required within parent	JSON path locating the dependee field within the request body. Maximum length: 512

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_92c01fd0c916

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the dependee field whose value determines the validation rules applied to the comparator of the criterion field in error. Contains the API name and JSON path of the dependee field. Additional keys: not allowed
api_name	string	Required within parent	API name of the dependee field whose value imposed the violated validation rule on the criterion field comparator. Maximum length: 256
json_path	string	Required within parent	JSON path locating the dependee field within the request body. Maximum length: 512

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_e2ab35a9b080

Field	Type	Presence	Description and constraints
$	object	Root	Represents the dependee field whose value determines the expected data type for the criterion field that raised the mismatch error. Contains the API name and JSON path of the dependee field. Additional keys: not allowed
api_name	string	Required within parent	API name of the dependee field that determines the expected data type for the criterion field in error. Maximum length: 256
json_path	string	Required within parent	JSON path locating the dependee field within the request body. Maximum length: 512

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_35444affca25

Field	Type	Presence	Description and constraints
$	object	Root	Contains detailed information about the data type mismatch, including the criterion field that raised the error, the dependee field whose value determines the expected data type, and the expected data type itself. Additional keys: not allowed
api_name	string	Required within parent	API name of the criterion field whose value does not match the expected data type. Maximum length: 256
dependee	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_e2ab35a9b080
expected_data_type	string	Required within parent	Data type expected for the criterion field value, as determined by the dependee field. Maximum length: 256
json_path	string	Required within parent	JSON path locating the criterion field whose value contains the data type mismatch. Maximum length: 512

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_e2ab35a9b080

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_721f3c6d2a2e

Field	Type	Presence	Description and constraints
$	object	Root	Object containing diagnostic detail about the dependency mismatch, including the criterion field with the invalid comparator value (api_name, json_path) and the dependee field that imposed the violated validation rule (dependee.api_name, dependee.json_path). Additional keys: not allowed
api_name	string	Required within parent	API name of the criterion field whose comparator value does not satisfy the dependency rule imposed by the dependee field. Maximum length: 256
dependee	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_92c01fd0c916
json_path	string	Required within parent	JSON path locating the criterion field with the invalid comparator value within the request body. Maximum length: 512

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_92c01fd0c916

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_db5566f3e189

Field	Type	Presence	Description and constraints
$	object	Root	Detailed information about the field comparator mismatch, including the API name and JSON path of the criterion field in error, the dependee field that governs valid comparator values, and the array of supported comparator values. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the criterion field whose comparator value does not match any of the supported values determined by the dependee field. Maximum length: 256
dependee	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_376507a1648c
json_path	string	Required within parent	Represents the JSON path locating the criterion field whose comparator value does not match any of the supported values determined by the dependee field. Maximum length: 512
supported_values	array	Required within parent	Contains the comparator values that are valid for the criterion field, as determined by the dependee field. Maximum items: 100 Minimum items: 1
supported_values[]	string	Each item	Represents one supported comparator value valid for the criterion field, as determined by the dependee field. Maximum length: 256

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details dependee — shared_dependee_376507a1648c

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Comparator Value Mismatch

Field	Type	Presence	Description and constraints
$	object	Root	Error schema returned when the comparator value itself does not satisfy the dependency validation rules imposed by the dependee field. Carries error code DEPENDENT_MISMATCH and includes details identifying the criterion field with the invalid comparator value, its dependee field (api_name, json_path), and the criterion field own api_name and json_path. Additional keys: not allowed
code	string	Required within parent	Error code identifying the comparator dependency mismatch condition. Possible values: DEPENDENT_MISMATCH. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_721f3c6d2a2e
message	string	Required within parent	Descriptive message providing details about the comparator value mismatch error. Maximum length: 512
status	string	Required within parent	Status of the response indicating the outcome of the request. Possible values: error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_721f3c6d2a2e

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Comparator Mismatch

Field	Type	Presence	Description and constraints
$	object	Root	Error schema returned when the comparator value supplied for a criterion field does not match the valid comparator values determined by its dependee field. Contains the error code DEPENDENT_MISMATCH and a details object identifying the criterion field, its dependee field, and the list of supported comparator values. Additional keys: not allowed
code	string	Required within parent	Error code identifying the type of field comparator mismatch condition. Possible values: DEPENDENT_MISMATCH. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_db5566f3e189
message	string	Required within parent	Represents the error message describing the comparator mismatch condition for the criterion field. Maximum length: 512
status	string	Required within parent	Represents the status of the error response. Possible values: error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_db5566f3e189

Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error — Field Value Mismatch

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when the data type of the value supplied for a criterion field does not match the expected data type determined by the dependee field. Returned with error code DEPENDENT_MISMATCH. Contains details identifying the mismatched criterion field, its dependee field, and the expected data type. Additional keys: not allowed
code	string	Required within parent	Represents the error code identifying the type of error condition encountered. Possible values: DEPENDENT_MISMATCH. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_35444affca25
message	string	Required within parent	Descriptive message providing details about the field value mismatch error. Maximum length: 512
status	string	Required within parent	Status of the response. Possible values: error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: DEPENDENT MISMATCH, status: error details — shared_details_35444affca25

Custom Views — response body — custom_views / custom_views / item / value / code: DUPLICATE DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the request contains duplicate values for a field that requires unique values. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the duplicate data error. Possible values: **DUPLICATE_DATA** - The request contains duplicate values for a field that requires unique values. Known values: DUPLICATE_DATA
details	object	Required within parent	Represents the additional details about the duplicate field. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field with the duplicate value. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path pointing to the duplicate field in the request body. Maximum length: 255
message	string	Required within parent	Represents the error message describing the duplicate data issue. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a field value in the request does not match the expected data type. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with the data type mismatch. Maximum length: 255
expected_data_type	string	Required within parent	Represents the expected data type for the field. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field with the data type mismatch. Maximum length: 255

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path, regex

Field	Type	Presence	Description and constraints
$	object	Root	Represents the validation error details returned when a field value fails regex pattern validation due to an incorrect data type. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field for which the regex pattern validation failed. Maximum length: 255
expected_data_type	string	Required within parent	Represents the data type expected for the field to pass regex pattern validation. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path to the field that failed regex pattern validation. Maximum length: 255
regex	string	Required within parent	Represents the expected regex pattern that the field value was required to match. Maximum length: 255

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail

Field	Type	Presence	Description and constraints
$	object	Root	Represents the API name details for a field in the request or response. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field. Maximum length: 255

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_b32221d14670

Field	Type	Presence	Description and constraints
$	object	Root	Contains structured information about the invalid comparator error. Identifies the offending criterion field by API name and JSON path, and provides the list of supported comparator values valid for the given field type. Additional keys: not allowed
api_name	string	Required within parent	API name of the criterion field for which an invalid comparator was specified. Maximum length: 256
json_path	string	Required within parent	JSON path locating the criterion field with the invalid comparator within the request body. Maximum length: 512
supported_values	array	Required within parent	Contains the comparator values that are valid for the criterion field type. Maximum items: 100 Minimum items: 1
supported_values[]	string	Each item	Represents one valid comparator value accepted for the criterion field type. Maximum length: 256

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_e03c5b069f4e

Field	Type	Presence	Description and constraints
$	object	Root	Contains the details of the invalid data type error, including the API name of the offending criterion field, its JSON path within the request body, and the data type that was expected. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the criterion field whose value was supplied with an invalid data type. Maximum length: 256
expected_data_type	string	Required within parent	Represents the data type that the API expected for the criterion field identified by the API name, against which the supplied value was validated. Maximum length: 256
json_path	string	Required within parent	Represents the JSON path that locates the specific field within the request body where the invalid data type was detected. Maximum length: 512

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Comparator

Field	Type	Presence	Description and constraints
$	object	Root	Error schema returned when the comparator specified in a criterion field is not one of the allowed comparator values for the given field type. Returned with error code INVALID_DATA. The details object identifies the offending field by API name and JSON path, and enumerates the supported comparator values. Additional keys: not allowed
code	string	Required within parent	Error code identifying the category of error. Possible values: INVALID_DATA. Known values: INVALID_DATA
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_b32221d14670
message	string	Required within parent	Descriptive error message conveying the nature of the invalid comparator condition to the caller. Maximum length: 512
status	string	Required within parent	Status of the response indicating the outcome of the request. Possible values: error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_b32221d14670

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data For Update CV

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the request contains invalid field values for a Custom View update. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid data error. Possible values: **INVALID_DATA** - The request contains invalid field values. Known values: INVALID_DATA
details	JSON	Required within parent	Represents the additional details about the invalid field.
details (anyOf 1)	Model	Alternative	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details
details (anyOf 2)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail
details (anyOf 3)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path
details (anyOf 4)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path, regex
message	string	Required within parent	Represents the error message describing the invalid data. Known values: invalid data, Special Characters are not allowed, Invalid Data, Please give a valid comparator, Invalid Data Type Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path, Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details api name, expected data type, json path, regex, Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Data Type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when a criterion field value is provided with an incorrect data type. Contains the error code, a descriptive message, the response status, and details identifying the offending field and its expected data type. Additional keys: not allowed
code	string	Required within parent	Represents the error code that identifies the category of validation failure. Possible values: INVALID_DATA - Indicates that the value provided for a criterion field does not match the expected data type. Known values: INVALID_DATA
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_e03c5b069f4e
message	string	Required within parent	Represents the error message describing the invalid data type failure in a form suitable for display or logging. Maximum length: 512
status	string	Required within parent	Represents the response status for this error response. Possible values: error - Indicates that the request failed due to an invalid data type on a criterion field. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — shared_details_e03c5b069f4e

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Id Fav

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the Custom View ID in the favorite operation request is invalid. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid ID error. Possible values: **INVALID_DATA** - The Custom View ID in the request is invalid. Known values: INVALID_DATA
details	object	Required within parent	Represents the additional details about the invalid Custom View ID. Additional keys: not allowed
details.id	string	Required within parent	Represents the invalid Custom View ID. Format: int64 Maximum length: 25
message	string	Required within parent	Represents the error message describing the invalid ID. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error — Invalid Index Fav

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the favorite index value in the request is invalid. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid index error. Possible values: **INVALID_DATA** - The favorite index value in the request is invalid. Known values: INVALID_DATA
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail
message	string	Required within parent	Represents the error message describing the invalid favorite index. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail

Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATAS, message: Special Characters are not allowed, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a field value in the request contains special characters that are not allowed. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the special character error. Possible values: **INVALID_DATAS** - The request contains special characters that are not allowed. Known values: INVALID_DATAS
details	Model	Required within parent	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details
message	string	Required within parent	Represents the error message indicating that special characters are not allowed. Possible values: **Special Characters are not allowed** - The field value contains invalid special characters. Known values: Special Characters are not allowed Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details

Custom Views — response body — custom_views / custom_views / item / value / code: LOOKUP LIMIT EXCEEDED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when the count of lookup fields used in criterion expressions exceeds the allowed limit. The error code is LOOKUP_LIMIT_EXCEEDED. The details object contains a used_in array (minItems: 1, maxItems: 10) in which each entry identifies an affected location by name and provides the relevant lookup fields and the applicable lookup limit. Additional keys: not allowed
code	string	Required within parent	Identifies the error code that signals the lookup field limit has been exceeded. Possible values: LOOKUP_LIMIT_EXCEEDED. Known values: LOOKUP_LIMIT_EXCEEDED
details	object	Required within parent	Provides structured information about the locations where the lookup field count exceeded the allowed limit. The required used_in array contains objects that each specify a location name (such as "criteria" or "cross_filters"), the lookup fields in use, and the applicable lookup limit. Additional keys: not allowed
details.used_in	array	Required within parent	Lists the locations (for example, "criteria" or "cross_filters") where lookup field usage exceeded the allowed limit. Each entry in the array contains a location name, the lookup fields involved, and the applicable lookup limit. The array contains between 1 and 10 items. Maximum items: 10 Minimum items: 1
details.used_in[]	object	Each item	Represents one location — such as criteria or cross_filters — where lookup field usage has exceeded the allowed limit. Each entry identifies the location by name, lists the offending lookup fields, and specifies the maximum number of lookup fields permitted in that location. Additional keys: not allowed
details.used_in[].lookup_fields	array	Required within parent	Lists the lookup fields present in the specified location that contributed to exceeding the allowed lookup field limit. Contains between 1 and 100 entries, each identifying a single lookup field by its API name. Maximum items: 100 Minimum items: 1
details.used_in[].lookup_fields[]	object	Each item	Represents one lookup field used in the specified criterion location that was counted against the lookup field limit. Each entry exposes the API name of the offending field. Additional keys: not allowed
details.used_in[].lookup_fields[].api_name	string	Required within parent	Specifies the API name of a lookup field that was counted against the lookup field limit for the specified location. Maximum length: 256
details.used_in[].lookup_limit	JSON	Required within parent
details.used_in[].lookup_limit (anyOf 1)	integer	Alternative	Specifies the maximum number of lookup fields permitted in the associated location, such as criteria or cross_filters. Format: int32
details.used_in[].lookup_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
details.used_in[].name	string	Required within parent	Identifies the location — such as criteria or cross_filters — where the lookup field count exceeded the allowed limit. Maximum length: 256
message	string	Required within parent	Contains a descriptive error message explaining why the lookup field limit was exceeded. Maximum length: 512
status	string	Required within parent	Indicates the outcome of the request. Possible values: error. Known values: error

Custom Views — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a required field is missing from a Custom View update request. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the missing required field. Possible values: **MANDATORY_NOT_FOUND** - A required field is missing from the update request. Known values: MANDATORY_NOT_FOUND
details	JSON	Required within parent	Represents the additional details about the missing required field.
details (anyOf 1)	Model	Alternative	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details
details (anyOf 2)	Model	Alternative	Expand Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail
message	string	Required within parent	Represents the error message describing the missing required field. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details — Api Name Detail, Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details

Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of associations that prevent the deletion of a Custom View, including the association type and the list of associated resources. Additional keys: not allowed
associations	array	Required within parent	Represents the list of associations that prevent the deletion of the Custom View. Maximum items: 50
associations[]	object	Each item	Represents an association entry containing the association type and the list of associated resources. Additional keys: not allowed
associations[].resources	array	Required within parent	Represents the list of resources associated with this association type. Maximum items: 100
associations[].resources[]	object	Each item	Represents a resource that prevents deletion when associated with the Custom View. Additional keys: not allowed
associations[].resources[].id	string	Required within parent	Represents the unique identifier of the associated resource. Format: int64 Maximum length: 25
associations[].resources[].name	string	Required within parent	Represents the display name of the associated resource. Maximum length: 255
associations[].type	string	Required within parent	Represents the association type, indicating the feature or module the resource belongs to. Maximum length: 50
id	string	Required within parent	Represents the unique ID of the Custom View that cannot be deleted. Format: int64 Maximum length: 25

Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed Details Update

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a resource cannot be updated due to active associations. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the not allowed update. Possible values: **NOT_ALLOWED** - The resource cannot be updated because it has active associations. Known values: NOT_ALLOWED
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details
message	string	Required within parent	Represents the error message describing why the update is not allowed. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details

Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error — Not Allowed For Update CVBy Id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the update request contains a field that cannot be modified. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the not allowed update. Possible values: **NOT_ALLOWED** - The specified field cannot be updated. Known values: NOT_ALLOWED
details	object	Required within parent	Represents the additional details about the field that triggered the error. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that triggered the NOT_ALLOWED error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path pointing to the field that triggered the NOT_ALLOWED error. Maximum length: 255
message	string	Required within parent	Represents the error message describing why the update is not allowed. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

CustomView creation — response body — custom_views / custom_views / item / value / code: LIMIT EXCEEDED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when the request exceeds the maximum number of Custom Views allowed. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the limit exceeded error. Possible values: **LIMIT_EXCEEDED** - The maximum number of Custom Views allowed for the edition has been reached. Known values: LIMIT_EXCEEDED
details	object	Required within parent	Represents the additional details for this error type. No structured detail data exists for this error. Additional keys: not allowed
message	string	Required within parent	Represents the error message describing the Custom View limit. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Delete Custom Views — response body — custom views custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful deletion response for a Custom View, including the status, code, and confirmation message. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the deletion operation. Possible values: **SUCCESS** - The Custom View deletion completed successfully. Known values: SUCCESS
details	Model	Required within parent	Expand Custom View creation — response body — custom views custom views item details
message	string	Required within parent	Represents the success message for the deletion operation. Maximum length: 255
status	string	Required within parent	Represents the status of the deletion response. Possible values: **success** - The operation was successful. Known values: success

Referenced models: Custom View creation — response body — custom views custom views item details

Delete Custom Views — response body — custom views custom views item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the deletion failure details for a Custom View, containing the error code, status, message, and additional context.
$ (anyOf 1)	Model	Alternative	Expand Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error
$ (anyOf 2)	Model	Alternative	Expand Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Referenced models: Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error, Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the Custom View ID provided for deletion is invalid or the view has already been deleted. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid data error. Possible values: **INVALID_DATA** - The Custom View ID in the request is invalid or already deleted. Known values: INVALID_DATA
details	object	Required within parent	Represents the additional details about the invalid Custom View ID. Additional keys: not allowed
details.id	string	Required within parent	Represents the ID of the invalid or already-deleted Custom View. Format: int64 Maximum length: 25
message	string	Required within parent	Represents the error message describing the invalid data issue. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a Custom View cannot be deleted due to active associations. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the not allowed deletion. Possible values: **NOT_ALLOWED** - The Custom View cannot be deleted because it has active associations. Known values: NOT_ALLOWED
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details
message	string	Required within parent	Represents the error message describing why the deletion is not allowed. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details

Get All Custom Views — response body

Field	Type	Presence	Description and constraints
$	object	Root	Get all custom views of a module Additional keys: not allowed
custom_views	array	Required within parent	List of custom views Maximum items: 200
custom_views[]	JSON	Each item	Custom view item
custom_views[] (allOf 1)	Model	All variants apply	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me
custom_views[] (allOf 2)	JSON	All variants apply	Custom view item with required fields
info	JSON	Required within parent	Pagination info for the response
info (allOf 1)	Model	All variants apply	Expand Get All Custom Views — response body — info count, default, more records, page, per page, translation
info (allOf 2)	JSON	All variants apply	Required pagination fields

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me, Get All Custom Views — response body — info count, default, more records, page, per page, translation

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a Custom View returned in the response, including its filter criteria, sort configuration, field list, and access control settings. Additional keys: not allowed
$modified_criteria	boolean	Optional	Indicates whether the filter criteria of the Custom View has been modified since it was originally created. Possible values: **true** - The criteria has been modified. **false** - The criteria has not been modified.
access_type	string	Optional	Represents the access type of the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator. Known values: shared, public, only_to_me
category	string	Optional	Represents the category of the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user. Known values: public_views, other_users_views, shared_with_me, created_by_me
created_by	JSON	Optional
created_by (anyOf 1)	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name
created_by (anyOf 2)	null	Alternative	No user associated
created_time	JSON	Optional
created_time (anyOf 1)	string	Alternative	Represents the date and time when the Custom View creation occurred. Format: date-time
created_time (anyOf 2)	null	Alternative	Represents the date and time when the Custom View creation occurred. Format: date-time
criteria	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria
cross_filters	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters
default	boolean	Optional	Indicates whether the Custom View is set as the default view for the module. Possible values: **true** - This is the default view. **false** - This is not the default view.
display_value	string	Optional	Represents the display label of the Custom View as shown to users. Maximum length: 50
favorite	JSON	Optional
favorite (anyOf 1)	null	Alternative	Represents the favorite order of the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
favorite (anyOf 2)	JSON	Alternative
favorite (anyOf 2) (anyOf 1)	integer	Alternative	Represents the favorite order of the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
favorite (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fields	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me fields
id	string	Optional	Represents the unique ID of the Custom View. Format: int64 Maximum length: 25
last_accessed_time	JSON	Optional
last_accessed_time (anyOf 1)	string	Alternative	Represents the date and time when the Custom View was last accessed. A null value indicates the view has not been accessed. Format: date-time
last_accessed_time (anyOf 2)	null	Alternative	Represents the date and time when the Custom View was last accessed. A null value indicates the view has not been accessed. Format: date-time
locked	boolean	Optional	Indicates whether the Custom View is locked and cannot be modified by users. Possible values: **true** - The view is locked. **false** - The view is not locked.
modified_by	JSON	Optional
modified_by (anyOf 1)	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name
modified_by (anyOf 2)	null	Alternative	No user associated
modified_time	JSON	Optional
modified_time (anyOf 1)	string	Alternative	Modification Time of the Custom View Format: date-time
modified_time (anyOf 2)	null	Alternative	Modification Time of the Custom View Format: date-time
name	string	Optional	Represents the name of the Custom View. Maximum length: 50
offline	boolean	Optional	Indicates whether the Custom View is available in offline mode. Possible values: **true** - The view is available offline. **false** - The view is not available offline.
shared_to	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to
sort_by	JSON	Optional	Represents the field used to sort the records in the Custom View.
sort_by (anyOf 1)	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me sort by api name, id
sort_by (anyOf 2)	null	Alternative	No sort is applied
sort_order	JSON	Optional	Represents the sort order applied to the records in the Custom View.
sort_order (anyOf 1)	string	Alternative	Represents the sort order applied to the Custom View. Possible values: **asc** - Ascending order. **desc** - Descending order. Known values: asc, desc
sort_order (anyOf 2)	null	Alternative	Represents no sort order applied to the Custom View.
system_defined	boolean	Optional	Indicates whether the Custom View is a system-defined view created by Zoho CRM. Possible values: **true** - The view is system-defined. **false** - The view is user-defined.
system_name	JSON	Optional
system_name (anyOf 1)	string	Alternative	Represents the system-defined name of the Custom View. A null value indicates the view does not have a system name. Maximum length: 50
system_name (anyOf 2)	null	Alternative	Represents the system-defined name of the Custom View. A null value indicates the view does not have a system name. Maximum length: 50

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me fields, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me sort by api name, id, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me created by id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents a user reference containing the user ID and display name. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the user. Format: int64 Maximum length: 25
name	string	Required within parent	Represents the display name of the user. Maximum length: 255

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value
$ (anyOf 2)	null	Alternative	No criteria is applied. The custom view returns all records.

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators.
$ (anyOf 1)	Model	Alternative	Expand Get territory by ID — response body — territories territories item deal rule criteria value
$ (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or

Referenced models: Get territory by ID — response body — territories / territories / item / deal_rule_criteria / group_operator: AND, OR, and, or, Get territory by ID — response body — territories territories item deal rule criteria value

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters

Field	Type	Presence	Description and constraints
$	JSON	Root	Cross-filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters array
$ (anyOf 2)	null	Alternative	No cross-filter criteria is applied.

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters array

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me cross filters array

Field	Type	Presence	Description and constraints
$	array	Root	Represents the list of cross-filter objects returned in the response, applied to the Custom View. Maximum items: 3 Minimum items: 0
$[]	object	Each item	Represents a single cross-filter object returned in the response, containing the relationship reference, filter criteria, and inclusion flag. Additional keys: not allowed
$[].criteria	Model	Required within parent	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value
$[].include_objects	boolean	Required within parent	Indicates whether records with matching related records were included in the filtered results.
$[].relation	JSON	Required within parent
$[].relation (allOf 1)	Model	All variants apply	Expand Get records from a specified module — request body — query cross filters item relation
$[].relation (allOf 2)	JSON	All variants apply

Referenced models: Get records from a specified module — request body — query cross filters item relation, Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me fields

Field	Type	Presence	Description and constraints
$	array	Root	Represents the list of fields included in the Custom View, each with display and pin configuration details. Maximum items: 250
$[]	object	Each item	Represents a field included in the Custom View, with configuration details such as pin status, pin order, and display width. Additional keys: not allowed
$[]._pin	boolean	Optional	Indicates whether the field is pinned in the Custom View. Possible values: **true** - The field is pinned. **false** - The field is not pinned.
$[]._pin_order	JSON	Optional
$[]._pin_order (anyOf 1)	integer	Alternative	Represents the order of the pinned field within the Custom View. Format: int32
$[]._pin_order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[]._width	JSON	Optional
$[]._width (anyOf 1)	integer	Alternative	Represents the display width of the field in pixels. Format: int32
$[]._width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].api_name	JSON	Optional
$[].api_name (anyOf 1)	string	Alternative	Represents the API name of the field included in the Custom View. Maximum length: 255
$[].api_name (anyOf 2)	null	Alternative	Represents the API name of the field included in the Custom View. Maximum length: 255
$[].id	JSON	Optional
$[].id (anyOf 1)	string	Alternative	Represents the unique ID of the field included in the Custom View. Format: int64 Maximum length: 25
$[].id (anyOf 2)	null	Alternative	Represents the unique ID of the field included in the Custom View. Format: int64 Maximum length: 25

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	array	Alternative	Represents the list of users, roles, groups, or territories the Custom View is shared with. Maximum items: 250
$ (anyOf 1)[]	Model	Each item	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to null item
$ (anyOf 2)	null	Alternative	Represents the list of users, roles, groups, or territories the Custom View is shared with. Maximum items: 250
$ (anyOf 2)[]	Model	Each item	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to null item

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to null item

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me shared to null item

Field	Type	Presence	Description and constraints
$	object	Root	Shared To Object Additional keys: not allowed
id	string	Required within parent	ID of the user/group Format: int64 Maximum length: 25
name	string	Optional	Name of the user/group Maximum length: 255
subordinates	JSON	Optional
subordinates (anyOf 1)	boolean	Alternative	Specify true if subordinates are included, false otherwise
subordinates (anyOf 2)	null	Alternative	Specify true if subordinates are included, false otherwise
type	string	Required within parent	Represents the type of the shared-to entity. Possible values: **territories** - The view is shared with a territory. **roles** - The view is shared with a role. **groups** - The view is shared with a group. **users** - The view is shared with a specific user. Known values: territories, roles, groups, users

Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me sort by api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to a field in the Custom View, identified by its API name and unique ID. Additional keys: not allowed
api_name	JSON	Optional
api_name (anyOf 1)	string	Alternative	Represents the API name of the field. A null value indicates no field is selected. Maximum length: 255
api_name (anyOf 2)	null	Alternative	Represents the API name of the field. A null value indicates no field is selected. Maximum length: 255
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique ID of the field. A null value indicates no field is selected. Format: int64 Maximum length: 25
id (anyOf 2)	null	Alternative	Represents the unique ID of the field. A null value indicates no field is selected. Format: int64 Maximum length: 25

Get All Custom Views — response body — info count, default, more records, page, per page, translation

Field	Type	Presence	Description and constraints
$	object	Root	Represents pagination metadata and category label translations for the Custom Views response. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the total number of Custom Views available for the specified module. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default	string	Optional	Represents the ID of the default Custom View for the module. Format: int64 Maximum length: 255
more_records	boolean	Optional	Indicates whether more records are available beyond the current page. Possible values: **true** - More records are available. **false** - No more records are available.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Represents the current page number of the paginated response. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Represents the number of Custom Views returned per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
translation	Model	Optional	Expand Get All Custom Views — response body — info count, default, more records, page, per page, translation translation

Referenced models: Get All Custom Views — response body — info count, default, more records, page, per page, translation translation

Get All Custom Views — response body — info count, default, more records, page, per page, translation translation

Field	Type	Presence	Description and constraints
$	object	Root	Represents the localized display labels for the Custom View category names. Additional keys: not allowed
created_by_me	string	Required within parent	Represents the display label for the created by me category of Custom Views. Maximum length: 255
other_users_views	string	Required within parent	Represents the display label for the other users' views category of Custom Views. Maximum length: 255
public_views	string	Required within parent	Represents the display label for the public views category of Custom Views. Maximum length: 255
shared_with_me	string	Required within parent	Represents the display label for the shared with me category of Custom Views. Maximum length: 255

Get Custom View By Id — response body — custom views, info

Field	Type	Presence	Description and constraints
$	object	Root	Get a specific custom view of a module using custom view ID Additional keys: not allowed
custom_views	array	Required within parent	List of custom views Maximum items: 1
custom_views[]	JSON	Each item	Custom view detail item
custom_views[] (allOf 1)	Model	All variants apply	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me
custom_views[] (allOf 2)	JSON	All variants apply	Custom view item with required fields
info	JSON	Required within parent	Additional information about the response
info (allOf 1)	Model	All variants apply	Expand Get All Custom Views — response body — info count, default, more records, page, per page, translation
info (allOf 2)	JSON	All variants apply	Custom view info with required fields

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me, Get All Custom Views — response body — info count, default, more records, page, per page, translation

Sort Order by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the bulk update success response containing a list of updated Custom View items. Additional keys: not allowed
custom_views	array	Required within parent	Represents the list of Custom View update success items. Maximum items: 200
custom_views[]	Model	Each item	Expand Sort Order by ID — response body — custom views item

Referenced models: Sort Order by ID — response body — custom views item

Sort Order by ID — response body — custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful update response for a Custom View operation, including the status, code, message, and updated view ID. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the update operation. Possible values: **SUCCESS** - The Custom View update completed successfully. Known values: SUCCESS
details	object	Required within parent	Represents the additional details for the successful update operation. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique ID of the updated Custom View. Format: int64 Maximum length: 25
message	string	Required within parent	Represents the success message for the update operation. Maximum length: 255
status	string	Required within parent	Represents the status of the update response. Possible values: **success** - The operation was successful. Known values: success

Sort Order — request body — body custom views item sort by

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to a field in the Custom View, identified by its API name and unique ID. Additional keys: not allowed
api_name	string or null	Optional	Represents the API name of the field. A null value indicates no field is selected. Maximum length: 255
id	string or null	Optional	Represents the unique ID of the field. A null value indicates no field is selected. Format: int64 Maximum length: 25

Sort Order — response body — custom views custom views item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the sort failure details for a Custom View, containing the error code, status, message, and additional context.
$ (anyOf 1)	Model	Alternative	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error
$ (anyOf 2)	Model	Alternative	Expand Sort Order — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error

Referenced models: Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error, Sort Order — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error

Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the sort field or sort order value in the request is invalid. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid data error. Possible values: **INVALID_DATA** - The sort field or sort order value in the request is invalid. Known values: INVALID_DATA
details	Model	Required within parent	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details Extra details
message	string	Required within parent	Represents the error message describing the invalid sort data. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details

Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details for an invalid or missing field, including the API name and JSON path. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path pointing to the invalid field in the request. Maximum length: 255

Sort Order — response body — custom_views / custom_views / item / value / code: MANDATORY NOT FOUND, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a required field is missing from a sort request. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the missing required field. Possible values: **MANDATORY_NOT_FOUND** - A required field is missing from the sort request. Known values: MANDATORY_NOT_FOUND
details	JSON	Required within parent	Represents the additional details about the missing required field.
details (allOf 1)	Model	All variants apply	Expand Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details
message	string	Required within parent	Represents the error message describing the missing required field. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Sort Order — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error details