Get Mass Delete Status
To get the status of the mass delete job scheduled previously.
Request URL
https://www.zohoapis.com/crm/v2/{module_api_name}/actions/mass_delete?job_id
module_api_name - API name of the module
job_id - The ID of the job from the response of Mass Delete Records
| Supported modules |
|---|
| Leads, Accounts, Contacts, Deals, Campaigns, Activities, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom |
Request Method
GET
Scope
scope=ZohoCRM.mass_delete.{module_name}.READ
| Possible module names |
|---|
| leads, accounts, contacts, deals, campaigns, activities, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom |
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| job_id (mandatory) | String | Specifies the unique ID of the mass delete job obtained in the response of Mass Delete Records. |
Response Structure
| Attribute | Data Type | Description |
|---|---|---|
| Status | String | Indicates the status of mass delete. Possible values are "COMPLETED", "SCHEDULED", "RUNNING", and "FAILED". |
| Failed_Count | Integer | Specifies the number of records that failed to be mass deleted |
| Deleted_ Count | Integer | Specifies the number of records that were successfully mass deleted |
| Total_Count | Integer | Specifies the total number of records that were scheduled to be mass deleted |
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 404 | NOT_FOUND | Empty response | The specified job_id is not found or invalid |
| 400 | MANDATORY_NOT_FOUND | mandatory param missing | The parameter "job_id" is not included in the request |
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/Accounts/actions/mass_delete?job_id= 4150868000001263027"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"