v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

ATS Candidate

Create ATS Candidate

To add a new ats candidate in the system, send the candidate information in the payload. ats candidate id will be sent back in case of a successful response

post/api/v2/core/ats-systems/{systemId}/ats-candidates

Path parameters

systemIdstring required

System ID of profile

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

autoGenerateCandidateIdboolean nullable

When true, auto-generate the candidate_id; only supported for system_id=talent_tracking and only when candidateId is not provided. Must not be set for other systems.

systemIdstring nullable

system if of candidate

urlsstring[] nullable

urls of candidate

candidateIdstring nullable

ATS Candidate id. Omit when autoGenerateCandidateId is true.

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