Cancel Scheduled Data Backup
Purpose
To cancel a previously scheduled data backup for your Zoho CRM account.
Endpoints
- PUT /backup/{id}/actions/cancel
Request Details
Request URL
{api-domain}/crm/bulk/{version}/backup/{id}/actions/cancel
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.bulk.backup.ALL
(or)
ZohoCRM.bulk.backup.UPDATE
Possible operation types
ALL - Full access to backup data and settings
UPDATE - Cancel a scheduled backup
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/bulk/v8/backup/4876876000001593003/actions/cancel"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Possible Errors
- INVALID_REQUEST_METHODHTTP 400
The request method is incorrect.
Resolution: Use the HTTP PUT method to make this API call. Any other request method will result in this error. - ALREADY_CANCELLEDHTTP 400
Backup is already canceled
Resolution: Specify a backup ID which is not canceled. - RESOURCE_NOT_FOUNDHTTP 400
The requested resource doesn't exist
Resolution: You have specified an invalid backup ID. Specify a valid backup ID. - INPROGRESSHTTP 400
Backup is in progress
Resolution: The data backup job you're trying to cancel is already in progress. You cannot cancel a backup job that is already in progress. - OAUTH_SCOPE_MISMATCHHTTP 401
The access token you have used to make this API call does not have the required scope.
Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes. - NO_PERMISSIONHTTP 403
Permission denied to create
Resolution: The user does not have permission to cancel a scheduled data backup. Contact your system administrator. - INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details. - INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.
Sample Response
Copied{
"backup": {
"status": "success",
"code": "SUCCESS",
"message": "Backup stopped successfully.",
"details": {
"id": "4876876000001593003"
}
}
}