Create a candidate

POST/ats/{connection_id}/candidate

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
first_namestring
last_namestring
emails array
titlestring
Candidate’s current job title
telephones array
company_namestring
Name of company where candidate currently works
image_urlstring
tagsstring array
addressobject
external_identifierstring
link_urlsstring array
URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)
origin enum
Valid values:
"AGENCY"
"APPLIED"
"INTERNAL"
"REFERRED"
"SOURCED"
company_idstring
(reference to AtsCompany)
sourcesstring array
date_of_birthdate
user_idstring
Employee ID that owns the relationship for this candidate (reference to HrisEmployee)
web_urlstring
experiences array
education array
skillsstring array
job_idsstring array
metadata array

Returns

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
first_namestring
last_namestring
emails array
titlestring
Candidate’s current job title
telephones array
company_namestring
Name of company where candidate currently works
image_urlstring
tagsstring array
addressobject
external_identifierstring
link_urlsstring array
URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)
origin enum
Valid values:
"AGENCY"
"APPLIED"
"INTERNAL"
"REFERRED"
"SOURCED"
company_idstring
(reference to AtsCompany)
sourcesstring array
date_of_birthdate
user_idstring
Employee ID that owns the relationship for this candidate (reference to HrisEmployee)
web_urlstring
experiences array
education array
skillsstring array
job_idsstring array
metadata array
const options = {
  method: 'POST',
  url: 'https://api.unified.to/ats/5de520f96e439b002043d8dc/candidate',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?