Zoho: Recycle bin schemas

5 Zoho schemas with complete fields and constraints.

Delete recycle-bin records — response body — recycle bin

Field	Type	Presence	Description and constraints
`$`	object	Root	Multi-status payload that combines per-item success and error entries when a bulk request partially succeeds. Additional keys: not allowed
`recycle_bin`	array	Required within parent	Represents the list of per-item results, where each entry is either a SuccessResponse for a successful item or an ErrorResponse for a failed item. Maximum items: 200
`recycle_bin[]`	JSON	Each item
`recycle_bin[] (anyOf 1)`	Model	Alternative	Expand Restore a Recycle Bin record — response body — recycle_bin / item / code: SUCCESS, status: success
`recycle_bin[] (anyOf 2)`	Model	Alternative	Expand Delete recycle-bin records — response body — recycle_bin / recycle_bin / item / status: error

Referenced models: Delete recycle-bin records — response body — recycle_bin / recycle_bin / item / status: error, Restore a Recycle Bin record — response body — recycle_bin / item / code: SUCCESS, status: success

Delete recycle-bin records — response body — recycle_bin / recycle_bin / item / status: error

Field	Type	Presence	Description and constraints
`$`	object	Root	Error payload returned when a recycle-bin request fails, including the error code, the error message, and context-specific details. Additional keys: not allowed
`code`	string	Required within parent	Error code identifying why the request failed. Possible values: INVALID_DATA, EXPECTED_FIELD_MISSING, EXPECTED_PARAM_MISSING, AMBIGUITY_DURING_PROCESSING, AUTHORIZATION_FAILED. Known values: INVALID_DATA, EXPECTED_FIELD_MISSING, EXPECTED_PARAM_MISSING, AMBIGUITY_DURING_PROCESSING, AUTHORIZATION_FAILED
`details`	object	Required within parent	Provides additional context about the error, such as the offending parameter, field, JSON path, expected data type, or record ID. The populated keys depend on the code value. Additional keys: not allowed
`details.ambiguity_due_to`	array	Optional	List of factors that caused ambiguity when the error is AMBIGUITY_DURING_PROCESSING, typically because two or more mutually exclusive restoration modes were supplied. Maximum items: 2
`details.ambiguity_due_to[]`	object	Each item	Represents a single ambiguity factor, identified by its API name and JSON path. Additional keys: not allowed
`details.ambiguity_due_to[].api_name`	string	Optional	Represents the API name of the ambiguity factor. Maximum length: 100
`details.ambiguity_due_to[].json_path`	string	Optional	Represents the JSON path of the ambiguity factor within the request body. Maximum length: 1000
`details.api_name`	string	Optional	Represents the API name of the field that caused the error. Maximum length: 100
`details.expected_data_type`	string	Optional	Represents the data type expected for the offending field when the error is due to an invalid data type. Possible values: jsonarray, jsonobject, string. Known values: jsonarray, jsonobject, string
`details.expected_fields`	array	Optional	List of fields that are expected in the request body when the error is EXPECTED_FIELD_MISSING. Maximum items: 3
`details.expected_fields[]`	object	Each item	Represents a single expected field, identified by its API name and JSON path. Additional keys: not allowed
`details.expected_fields[].api_name`	string	Optional	Represents the API name of the expected field. Maximum length: 100
`details.expected_fields[].json_path`	string	Optional	Represents the JSON path of the expected field within the request body. Maximum length: 1000
`details.id`	string	Optional	Represents the record identifier associated with the error. Format: int64
`details.json_path`	string	Optional	Represents the JSON path to the request body field that caused the error. Maximum length: 1000
`details.param_name`	string	Optional	Represents the name of the request parameter that caused the error. Possible values: filters, ids. Known values: filters, ids
`details.param_names`	array	Optional	List of request parameter names that are expected but missing when the error is EXPECTED_PARAM_MISSING. Maximum items: 2
`details.param_names[]`	string	Each item	Name of an expected request parameter that was not supplied. Possible values: filters, ids, restore_all_records. Known values: filters, ids, restore_all_records
`details.resource_path_index`	JSON	Optional
`details.resource_path_index (anyOf 1)`	integer	Alternative	Represents the zero-based index of the resource path segment that caused the error. Format: int32
`details.resource_path_index (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`message`	string	Required within parent	Message that describes the cause of the error. Maximum length: 500
`status`	string	Required within parent	Indicates that the API request failed. Possible values: error. Known values: error

Restore a Recycle Bin record — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Wrapper that returns the per-item results of a recycle-bin operation under the recycle_bin array. Additional keys: not allowed
`recycle_bin`	array	Required within parent	List of per-item results for the operation. Each entry is either a success result or a scheduled-job result. Maximum items: 200
`recycle_bin[]`	JSON	Each item
`recycle_bin[] (anyOf 1)`	Model	Alternative	Expand Restore a Recycle Bin record — response body — recycle_bin / item / code: SUCCESS, status: success
`recycle_bin[] (anyOf 2)`	Model	Alternative	Expand Restore a Recycle Bin record — response body — recycle_bin / item / code: SCHEDULED, status: success

Referenced models: Restore a Recycle Bin record — response body — recycle_bin / item / code: SUCCESS, status: success, Restore a Recycle Bin record — response body — recycle_bin / item / code: SCHEDULED, status: success

Restore a Recycle Bin record — response body — recycle_bin / item / code: SCHEDULED, status: success

Field	Type	Presence	Description and constraints
`$`	object	Root	Result returned when a recycle-bin operation is queued as a background job because it cannot complete synchronously. Additional keys: not allowed
`code`	string	Required within parent	Result code indicating that the operation is scheduled. Possible values: SCHEDULED. Known values: SCHEDULED
`details`	object	Required within parent	Represents additional details about the scheduled operation. This is typically an empty object or contains a record ID associated with the scheduled job. Additional keys: allowed
`message`	string	Required within parent	Represents the message confirming that the operation has been queued as a background job. Maximum length: 500
`status`	string	Required within parent	Indicates that the request to schedule the operation succeeded. Possible values: success. Known values: success

Restore a Recycle Bin record — response body — recycle_bin / item / code: SUCCESS, status: success

Field	Type	Presence	Description and constraints
`$`	object	Root	Per-item result returned when a single recycle-bin record is processed successfully. Additional keys: not allowed
`code`	string	Required within parent	Result code for the per-item operation. Possible values: SUCCESS. Known values: SUCCESS Maximum length: 100
`details`	object	Required within parent	Represents additional details about the per-item operation, including the affected record ID. Additional keys: not allowed
`details.id`	string	Optional	Represents the unique identifier of the recycle-bin record that the per-item result refers to. Maximum length: 500
`message`	string	Required within parent	Represents the message that describes the outcome of the per-item operation. Maximum length: 500
`status`	string	Required within parent	Indicates that the per-item operation succeeded. Possible values: success. Known values: success

Report an issue with this page