v1

latestOpenAPI 3.0.32026-08-06224144516.1 KB
Candidates

Create a candidate

As with all POST endpoints, a location header will be returned with a url to the newly created resource.

post/candidates

Query parameters

check_duplicateboolean required

When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false.

Request body

first_namestring required
middle_namestring
last_namestring required
titlestring

The candidate's job title.

country_codestring
websitestring
best_time_to_callstring
current_employerstring
date_availablestring

The date the candidate is available for an opening.

current_paystring
desired_paystring
is_willing_to_relocateboolean
key_skillsstring
notesstring
sourcestring
owner_idnumber

The user id of the record owner

is_activeboolean

A flag indicating if the candidate is active.

is_hotboolean

A flag indicating if the candidate should be marked as hot. A hot candidate is highlighted in the candidates view.

passwordstring

The candidate's password if they are "registering". Registered candidate can be authenticated with /candidates/authorization.

Response

Created