Create Submission

Candidate_Name*

String

The unique ID of the Candidate who is being submitted to the Client (or) Hiring Manager.

100001000000043143

Client_Name*
(or)
Department_Name*

String

The unique ID of the Client or Department for which the Candidate is being submitted.

100001000000042459

Job_Opening_Name*

String

The unique ID of the Job Opening for which the Candidate is being submitted.

100001000000046547

Submitted_To*

JSONArray

Staffing Agency edition:
List of contacts the candidate is being submitted to.

Corporate HR edition:
The hiring manager the candidate is being submitted to.

Staffing Agency Edition

"Submitted_To": [{
   "name": "Graham Hancock",
   "id": "100001000000026793"
}, {
   "name": "Robert Wilson",
   "id": "100001000000026794"
}]

Corporate HR Edition

"Submitted_To": "100001000000042433"

Application_Name (optional)

String

The name of the application for which you wish to create a submission.

If the Application_Name parameter is passed in the request, then both Job_Opening_Name and Candidate_Name parameters become optional.

100001000000042437

$medium*

String property

This value denotes the medium through which the submission was made, i.e, whether the submission was made via email or shared to the contact's client portal account.

Note: The value of the $medium parameter can be passed as Share only if you are using the Staffing Agency edition of Zoho Recruit as it shares the candidate to the contact's client portal account.

The $description parameter can be used to provide additional details/context to the contact you are sharing the candidate with.

Email/Share

$mail_content
(if $medium = Email)

JSONObject property

The following properties can be included to this parameter;

• from_address

• reply_to_address

• cc_address

• bcc_address

• subject

• description

• template_id *

• editor_mode

• isSeparatEmail
   

Note: If you are submitting candidates in bulk and the isSeparateEmail property is included under the $mail_content parameter, then each submission is sent as a separate email.

{

    "from_address": "robert.bauer@zylker.com",

    "subject": "Candidate Submission for Accountant | Zylker",

    "description": "Please find the candidate's details attached with this email.",

    "template_id": "100001000000021175"

}

Description
(if $medium = Share)

String

The comments provided while submitting candidates via the Share option.

Character Limit: 32000

"Please consider these 3 candidates for the Accountant position."

400

RECORD_LOCKED

Actions aren't allowed for locked records. Unlock the record and try again

This error is thrown if the associated candidate (or) job opening is locked.

400

NOT_APPROVED

record not approved

This error is thrown if the associated candidate (or) job opening is involved in an approval process.

400

RECORD_LOCKED

Record has been locked from processing

This error is thrown if the associated candidate (or) job opening is locked from processing based on GDPR guidelines.

400

INVALID_DATA

You cannot add submission record since it is locked in blueprint.

This error is thrown if the associated candidate (or) job opening is involved in a blueprint process.

400

INVALID_DATA

api_name: Client_Name/Candidate/Job Opening

message: invalid data

This error is thrown if the Candidate, Client or Job Opening name included in your request is invalid.

400

INVALID_DATA

api_name: template_id

message: invalid data

This error will be thrown if the template_id included in your request is invalid.

400

UNCONFIRMED_USER

unconfirmed from address

This error will be thrown if the From address used to submit candidates is unconfirmed.

400

INVALID_DATA

api_name: Submitted_To

message: invalid data

This error is thrown if the value passed for the Submitted_To parameter is invalid.

400

MANDATORY_NOT_FOUND

required field not found

This error is thrown if not all mandatory parameters are included in your request.

403

FEATURE_NOT_SUPPORTED

your edition doesn't support this feature

This error is thrown if you pass $medium as Share in your request and your edition is Corporate HR.

403

FEATURE_DISABLED

client portal disabled

This error is thrown if you pass Share as the value for the $medium parameter in your request but Client portal is disabled.