HomeGuidesAPI ReferenceChangelogDiscussions
API Reference

Creates a Candidate

Creates candidates related to a particular company in an ATS

Log in to see full request history
Body Params
string
required

first name of the candidate.

string
required

last name of the candidate.

string

email of the candidate.

integer
required

company identifier, refers to /core/me endpoint.

boolean

is the candidate part of talent pool?

string
string

source of the candidate.

string

specifies additional details related to the source of the candidate, such as the referrer name for example if the source is referred.

string

phone number of the candidate.

string

personal web resource from the candidate.

string

gender of the candidate.

Response

Response body
object
integer
required

identifier of the candidate.

integer

company identifier.

string
required

name of the candidate.

string
required

last name of the candidate.

string
required

full name of the candidate.

string

email of the candidate.

boolean
required

is the candidate part of talent pool?

string

phone number of the candidate.

string
required

creation date of the candidate.

string
required

last update of the candidate.

string
string

date when the candidate became inactive.

ats_job_posting_ids
array of integers

list of job posting identifiers.

ats_job_posting_ids
string

personal web resource from the candidate.

string
boolean
string

specifies additional details related to the source of the candidate, such as the referrer name for example if the source is referred.

integer

candidate source identifier, refers to ats/candidate_sources endpoint.

string

gender of the candidate.

female male unanswered other

number

score of the candidate.

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json