v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

ATS Candidate

Patch ATS Candidate

Given an ats candidate id and data that needs to be patched, it patches the ats candidate. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

patch/api/v2/core/ats-systems/{systemId}/ats-candidates/{atsCandidateId}

Path parameters

atsCandidateIdstring required

ATS entity ID of candidate

systemIdstring required

System ID of profile

Query parameters

refreshClaimedProfilestring

Set to 'true' if updates need to be processed for this profile despite it being claimed. Defaults to false

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Request body

locationCountrystring nullable

location country of candidate

contactConsentstring nullable

Contact consent for candidate. Valid inputs: applied_only, all, country_only

isAnonymizedboolean nullable

is anonymized candidate

skillsstring[] nullable

skills of candidate

locationstring nullable

location of candidate

addressstring nullable

address of candidate

firstNamestring required

first name of candidate

emailsstring nullable required

email of candidate

visaStatusesstring[] nullable

visa statuses of candidate

veteranStatusStrstring nullable

String value for veteran status of the candidate

isInternalboolean nullable

is internal candidate

customInfoobject nullable

custom info of candidate

systemIdstring nullable

system if of candidate

urlsstring[] nullable

urls of candidate

candidateIdstring nullable required

ATS Candidate id

titlestring nullable

title of candidate

displayTagsstring[] nullable

display tags for candidate

tagsstring[] nullable

tags of candidate

veteranStatusboolean nullable

Boolean value for veteran status of the candidate

highestEducationLevelstring nullable

highest education level of candidate

lastActivityTsinteger nullable required

last activity time stamp of candidate

summarystring nullable

summary of candidate

disabilityStatusboolean nullable

disability status

phonesstring nullable

comma separated phone numbers of candidate

racesstring[] nullable

race of candidate

dateOfBirthstring nullable

date of birth of candidate

genderstring nullable

gender of candidate

disabilityStatusStrstring nullable

disability status of an applicant

lastNamestring nullable

last name of candidate

Response

transactionIdstring nullable