Retrieves the current patch approval settings (automatic or manual).
get /api/1.4/patch/approvalsettings
https://{serverurl}/api/1.4/patch/approvalsettings Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.
Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.
Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.
Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.
Name of the column (field) in the response by which the records are sorted. Use together with sortorder.
Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.
Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.
curl --request GET \
--url https://appdomains/api/1.4/patch/approvalsettings \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: approvalsettings
Patch approval settings data
Approval settings details
Approval mode: automatic or manual
API version: 1.0
Operation status: success
Response code: 200
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
{
"message_type": "approvalsettings",
"message_response": {
"approvalsettings": {
"patch_approval": "automatic"
}
},
"message_version": "1.0",
"status": "success",
"response_code": 200
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.