uploadDocument

uploadDocument

Purpose

You can use this API to parse and upload candidates resumes in Zoho Recruit from third-party applications. This is available only in the Paid Edition.
Note: Use the POST method to pass these parameters instead of GET method.

Request URL

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
documentData*
String
Base64 encoded string of the document to be uploaded.
fileName*
String
Specify the file name and the file format.
country
String
Values allowed 

AR|AU|BE|CZ|FR|DE|GR|HU|IN|IE|IT|NL|NO|RU|ZA|ES|SE|GB|USA

source
String
Specify any text.
version*
Integer
 Use version=2: This will fetch responses based on the latest API implementation
Note: Parameters marked with * are mandatory.

Example

To parse and upload candidate resumes in Zoho Recruit from third-party applications.
URL Format:
authtoken=7d987658943g4j09h43dd0b167dda34b&scope=recruitapi&version=2&country=RU&fileName=johnCV.txt&documentData=
TmFtZTogVG9ueQ0KDQpFbWFpbDogdG9ueUB6b2hvY29ycC5jb20NCg0KTG9jYXRpb246IENoZW5uYWk%3D
Response Format:
<response uri="/recruit/private/xml/Candidates/uploadDocument">
<result>
<message>Candidate added successfully</message>
<recorddetail>
<FL val="Id">292114000000373049</FL>
</recorddetail>
</result>
</response>
Note: You can upload a maximum of 250 documents per day.

    • Related Articles

    • API Methods

      Method Name Purpose getRecords To retrieve all users data specified in the API request getRecordById To retrieve individual records by record ID addRecords To insert records into the required Zoho Recruit module updateRecords To update or modify the ...