v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
ats
candidate

Update a candidate

put/ats/{connection_id}/candidate/{id}

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Candidate

Query parameters

fieldsstring[]

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

Request body

idstring
created_atstring date-time
updated_atstring date-time
namestring
first_namestring
last_namestring
titlestring
company_namestring
image_urlstring
tagsstring[]
external_identifierstring
link_urlsstring[]

URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)

origin'AGENCY' | 'APPLIED' | 'INTERNAL' | 'REFERRED' | 'SOURCED' | 'UNIVERSITY'
company_idstring
sourcesstring[]
date_of_birthstring date-time
user_idstring
user_idsstring[]

references hris employees

web_urlstring
skillsstring[]
job_idsstring[]
rawobject

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
first_namestring
last_namestring
titlestring
company_namestring
image_urlstring
tagsstring[]
external_identifierstring
link_urlsstring[]

URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)

origin'AGENCY' | 'APPLIED' | 'INTERNAL' | 'REFERRED' | 'SOURCED' | 'UNIVERSITY'
company_idstring
sourcesstring[]
date_of_birthstring date-time
user_idstring
user_idsstring[]

references hris employees

web_urlstring
skillsstring[]
job_idsstring[]
rawobject