Schedule Data Backup


To schedule a backup of all CRM data including attachments. You can schedule the backup to happen at selected times, or daily. The result is available as a downloadable ZIP file.

Request URL

Request Method




Possible operation types
ALL - Full access to backup data
CREATE - Schedule a backup

Request JSON


If you want to backup CRM data immediately, leave the input body empty.

AttributeData TypeMandatoryDescription
rrule Show propertiesStringYes, if you want to schedule a backup at a certain time.The recurring pattern to schedule a data backup at certain intervals.

A few other examples of rrule:

    This rrule schedules three backups that happen every Wednesday in the second week of the month.

  • "rrule": "FREQ=MONTHLY;INTERVAL=2;COUNT=3;BYMONTHDAY=14". This rrule schedules three backups that happen on the 14th day of the month, and repeat once in two months.

Response Structure

AttributeData TypeDescription
statusStringRepresents the status of the scheduled backup.
codeStringRepresents the status code of the scheduled backup.
messageStringRepresents the success message or the reason for error, if any.
detailsShow propertiesJSON ObjectDetails of the scheduled backup.

Possible Errors

HTTP StatusError CodeMessageReason
400INVALID_DATAInvalid datarrule pattern is incorrect. Provide the right rrule pattern.
400LIMIT_EXCEEDEDYou have reached the maximum backup limit in your current edition.You have exhausted the maximum number of available backups for your CRM edition. You can wait till the next month when your data backup limits are refreshed or purchase additional backup.
400BACKUP_ALREADY_SCHEDULEDBackup is already scheduledYou have already scheduled a backup. You must wait for the scheduled backup to complete before you can schedule another.
403NO_PERMISSIONpermission deniedYou do not have the permission to schedule a backup. Users with Administrator profile can only schedule a backup.

Sample Request

Copiedcurl ""
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"

Sample Input

  "backup": {
    "rrule": "RRULE:FREQ=DAILY;COUNT=3"

Sample Response

    "backup": {
        "status": "success",
        "code": "SUCCESS",
        "message": "Backup scheduled successfully.",
        "details": {
            "id": "3652397000001730002",
            "scheduled_date": null,
            "start_date": null,
            "rrule": null,
            "requester": null,
            "status": null