Delete Records
Purpose
To delete entities or records from a module.
Request URL
https://recruit.zoho.com/recruit/v2/{module_api_name}?ids={record_id}
To delete a specific record;
https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}
module_api_name - The API name of the module
record_id - The unique Id of the record
EntityID - The unique ID of the entity or record
Modules supported in Get List of Records are supported here.
Request Method
DELETE
Scope
scope=ZohoRecruit.modules.all
(or)
scope=ZohoRecruit.modules.{module_name}.{operation_type}
Possible module names | Possible operation types |
---|---|
candidate, application, jobopening, interview, client, contact, department, task, event, vendor, campaign, and custommodule | ALL - Full access to the record WRITE - Edit records in the module DELETE - Delete records in the module |
Parameters
Parameter Name | Data Type | Description | Possible Values |
---|---|---|---|
ids (mandatory) | Integer | Specify the unique ID of the record | Entity IDs separated by commas. For example: 410405000002264040, 410405000002264025 |
wf_trigger (optional) | Boolean | Represents if the workflow rules are to be triggered upon record deletion. The value true triggers workflows. The value false does not trigger workflows. The default value is true. | true (or) false |
Note:
A maximum of 100 records can be deleted per API call.
By default, all the workflows related to this API will get executed.
All the subforms related to this API will get deleted.
Sample Request
Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates?ids=486812000001660087,486812000001336264"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "486812000001660087"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "486812000001336264"
},
"message": "record deleted",
"status": "success"
}
]
}