Schedule Data Backup
Purpose
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
https://www.zohoapis.com/crm/bulk/v2/backup
Request Method
POST
Scope
scope=ZohoCRM.bulk.backup.ALL
(or)
scope=ZohoCRM.bulk.backup.CREATE
| Possible operation types |
|---|
| ALL - Full access to backup data CREATE - Schedule a backup |
Request JSON
Note
If you want to backup CRM data immediately, leave the input body empty.
| Attribute | Data Type | Mandatory | Description |
|---|---|---|---|
| rrule Show properties | String | Yes, 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:
"rrule": "FREQ=MONTHLY;COUNT=3;BYDAY=WE;"
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
| Attribute | Data Type | Description |
|---|---|---|
| status | String | Represents the status of the scheduled backup. |
| code | String | Represents the status code of the scheduled backup. |
| message | String | Represents the success message or the reason for error, if any. |
| details | ||
| detailsShow properties | JSON Object | Details of the scheduled backup. |
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | INVALID_DATA | Invalid data | rrule pattern is incorrect. Provide the right rrule pattern. |
| 400 | LIMIT_EXCEEDED | You 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. |
| 400 | BACKUP_ALREADY_SCHEDULED | Backup is already scheduled | You have already scheduled a backup. You must wait for the scheduled backup to complete before you can schedule another. |
| 403 | NO_PERMISSION | permission denied | You do not have the permission to schedule a backup. Users with Administrator profile can only schedule a backup. |
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/bulk/v2/backup"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"Sample Input
Copied{
"backup": {
"rrule": "RRULE:FREQ=DAILY;COUNT=3"
}
}Sample Response
Copied{
"backup": {
"status": "success",
"code": "SUCCESS",
"message": "Backup scheduled successfully.",
"details": {
"id": "3652397000001730002",
"scheduled_date": null,
"start_date": null,
"rrule": null,
"requester": null,
"status": null
}
}
}