POST
/
zapier
/
create-candidate
curl --request POST \
  --url https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "primaryEmail": "jsmith@example.com",
  "name": "<string>",
  "title": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "links": {},
  "education": "<string>",
  "experienceYears": 1073741823.5,
  "resumeUrl": "<string>",
  "noticeWeeks": 1073741823.5,
  "earliestStartDate": "<string>",
  "currentSalary": 1073741823.5,
  "currentSalaryCurrency": "USD",
  "expectedSalary": 1073741823.5,
  "expectedSalaryMax": 1073741823.5,
  "expectedSalaryCurrency": "USD",
  "isVeteran": true,
  "creatorId": "<string>",
  "workspaceId": "<string>",
  "countryIso3": "<string>",
  "zipCode": "<string>",
  "address": "<string>",
  "city": "<string>",
  "notes": "<string>",
  "jobId": "<string>"
}'
{
  "id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
workspaceId
string
required
​
primaryEmail
string | null
​
name
string | null
​
title
string | null
​
emails
string[]
​
phone
string | null
​
links
object
​
education
string | null
​
experienceYears
number | null
Required range: 0 <= x <= 2147483647
​
resumeUrl
string
​
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

200
application/json
Successfully upserted the candidate
​
id
string
required