Zoho Recruit | deleteTabularRecords Method

deleteTabularRecords

Purpose
You can use the deleteTabularRecords method to delete tabular information from a specified record. Each tabular can have up to 10 entries. You can delete then all at once or individually.

Type:  Post 

URL Format  
https://recruit.zoho.com/recruit/private/xml/<Module Name>/deleteTabularRecords?authtoken=<authtoken>&id=<id>&tabularName=<TabularName>&deleteType=(all or partial)&tabularRowIds=<tabular row ids>&scope=recruitapi

For OAuth Authentication

Header Name
Value
Authorization
Zoho-oauthtoken {access_token}

Scopes

Scope=ZohoRecruit.modules.all
(or)
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
Possible Scope Names (Case Sensitive)
Operation Types
referral, campaign, assessment, vendor, offer,  attachment, 
forecast, note, call, event, task,  candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules )
ALL - Full access to the record
READ - Get records from the module

For Authtoken Authentication

Parameter
Data Type
Description
authtoken*
String
Encrypted alphanumeric string to authenticate your Zoho credentials. 
scope*
String
Specify the value as recruitapi

Request Parameters

Parameter
Data Type
Description
id*
String
Specify the unique ID of the record.

tabularName*

String
Name of the tabular entry where you want to delete data from.
deleteType*
String
Specify "all" or "partial" according to your requirements

tabularRowIds

String
Comma separated tabular row ids to specify what tabular information to delete. Applicable only if deleteType is partial.

Note:

  1. Parameters marked with * are mandatory
  2. Specify deleteType as "all" to delete all tabular information for a specified record 
  3. Specify deleteType as "partial" to delete selected tabular information for a specified record. Provide tabularRowIds in comma separated format.

For deleteType = all

Sample Request 
Response  
<?xml version="1.0" encoding="UTF-8"?>
<response uri="/recruit/private/xml/Candidates/deleteTabularRecords">
<result>
<Candidates>Data deleted successfully.</Candidates>
</result>
</response>

For deleteType = partial

Sample Request
https://recruit.zoho.com/recruit/private/xml/Candidates/deleteTabularRecords
?authtoken=abbdd****&id=368078000002898016&tabularName=Educational
Details&deleteType=partial&tabularRowIds=100002000000051023,1000020000000510
24,100002000000051025

Response 

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/crm/private/xml/Candidates/deleteTabularRecords">

<result>
<Candidates>

<FL
val="Deleted">100002000000051023,100002000000051024,100002000000051025</FL>

</Candidates>
</result>

</response>