Skip to main content
POST
Upserts candidate

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required
primaryEmail
string<email> | null
name
string | null
title
string | null
emails
string<email>[]
phone
string | null
education
string | null
experienceYears
number | null
Required range: 0 <= x <= 2147483647
resumeUrl
string<uri>
noticeWeeks
number | null
Required range: 0 <= x <= 2147483647
earliestStartDate
string | null
currentSalary
number | null
Required range: 0 <= x <= 2147483647
currentSalaryCurrency
enum<string> | null
Available options:
USD,
EUR,
GBP,
EGP,
AED,
SAR
expectedSalary
number | null
Required range: 0 <= x <= 2147483647
expectedSalaryMax
number | null
Required range: 0 <= x <= 2147483647
expectedSalaryCurrency
enum<string> | null
Available options:
USD,
EUR,
GBP,
EGP,
AED,
SAR
isVeteran
boolean | null
creatorId
string | null
countryIso3
string | null
zipCode
string | null
address
string | null
city
string | null
notes
string | null
jobId
string

Response

Successfully upserted the candidate

id
string
required