Cancel Scheduled Data Backup

Purpose

To cancel the scheduled data backup of your CRM account.

Endpoints

Request Details

Request URL

{api-domain}/crm/bulk/v3/backup/{id}/actions/cancel

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.bulk.backup.ALL
(or)
scope=ZohoCRM.bulk.backup.UPDATE

Possible operation types

ALL - Full access to backup data
UPDATE - Cancel a scheduled backup

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/bulk/v3/backup/4876876000001593003/actions/cancel"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required scope for canceling Data Backup. Create a new client with valid scope. Refer to scope section above for more details.

  • NO_PERMISSIONHTTP 403

    Permission denied to create
    Resolution: The user does not have permission to cancel a scheduled data backup. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • 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.

Sample Response

Copied{
    "backup": {
        "status": "success",
        "code": "SUCCESS",
        "message": "Backup stopped successfully.",
        "details": {
            "id": "4876876000001593003"
        }
    }
}