Skip to main content
POST
Create candidate

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Request body for creating a candidate via JSON.

job_id
integer
required

Numeric id of a job owned by the authenticated company.

Required range: x >= 1
Example:

40

name
string
required

Candidate name after trimming.

Required string length: 1 - 200
Example:

"Jane Doe"

email
string<email> | null

Optional candidate email. Used in duplicate detection by job.

Example:

"jane@example.com"

phone
string | null

Optional phone number. Normalized where possible.

Maximum string length: 100
Example:

"+61 412 345 678"

linkedin
string<uri> | null

Optional LinkedIn profile URL.

Example:

"https://linkedin.com/in/janedoe"

location
string | null

Optional freeform location string.

Maximum string length: 500
Example:

"Sydney, Australia"

stage
enum<string>

Optional initial stage. Defaults to prospect.

Available options:
prospect,
applied,
phonescreen,
inprogress,
hired,
rejected
Example:

"prospect"

notes
string | null

Optional note that creates a note_added activity row.

Maximum string length: 2000
Example:

"Referred by internal team"

Response

Candidate created

Wrapper for a single candidate resource.

data
object
required

Public representation of a candidate.

Example: