Mass Delete Status
Purpose
To get the status of the mass delete job scheduled previously.
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/actions/mass_delete?job_id={job_id}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Meetings, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Services, Appointments, and Custom
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.mass_delete.READ
(or)
scope=ZohoCRM.mass_delete.{module_name}.READ
Parameters
- job_idstring, mandatory
Specifies the unique ID of the mass delete job obtained in the response of Mass Delete Records.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v7/Leads/actions/mass_delete?job_id= 3652397000009565021"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Response JSON Keys
- Statusstring
Indicates the status of the mass delete API. Possible values are "COMPLETED", "RUNNING", and "FAILED".
- Total_Countinteger
Specifies the total number of records that were scheduled to be deleted.
- Failed_Countinteger
Specifies the number of records that were not deleted.
- Deleted_Countinteger
Specifies the number of records that were deleted successfully.
Sample Response
Copied{
"data": [
{
"Status": "COMPLETED",
"Failed_Count": 0,
"Deleted_Count": 9,
"Total_Count": 9
}
]
}