API End Points

Patch ATS Candidate

patch
https://apiv2.{domain}.ai/api/v2/core/ats-systems//ats-candidates/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ATS entity ID of candidate

string
required

System ID of profile

Query Params
string

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

Body Params
string | null

location country of candidate

string | null

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

boolean | null

is anonymized candidate

scheduledInterviews
array of objects | null

scheduled interviews of candidate

scheduledInterviews
skills
array of strings | null

skills of candidate

skills
string | null

location of candidate

string | null

address of candidate

string
required

first name of candidate

detailTags
array of objects | null

detail tags of candidate

detailTags
string | null
required

email of candidate

attachments
array of objects | null

Attachments of candidate

attachments
resumeContent
object | null

Resume content for candidate.

visaStatuses
array of strings | null

visa statuses of candidate

visaStatuses
education
array of objects | null

education of candidate

education
boolean | null

is internal candidate

customInfo
object | null

custom info of candidate

courseAttendance
array of objects | null

course attandance of candidate

courseAttendance
string | null

system if of candidate

string | null
required

ATS Candidate id

urls
array of strings | null

urls of candidate

urls
string | null

title of candidate

displayTags
array of strings | null

display tags for candidate

displayTags
tags
array of strings | null

tags of candidate

tags
boolean | null

Boolean value for veteran status of the candidate

string | null

highest education level of candidate

certifications
array of objects | null

certifications for candidate

certifications
int32 | null
required

last activity time stamp of candidate

string | null

summary of candidate

photoContent
object | null

Photo content.

applications
array of objects | null

applications of candidates

applications
boolean | null

disability status

string | null

comma separated phone numbers of candidate

experience
array of objects | null

experience of candidate

experience
races
array of strings | null

race of candidate

races
string | null

date of birth of candidate

project
array of objects | null

project of candidate

project
notes
array of objects | null

notes of candidates

notes
string | null

gender of candidate

questions
array of objects | null

questions of candidate

questions
skillDetails
array of objects | null

skill details of candidate

skillDetails
string | null

last name of candidate

Headers
string
required

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

Response

Updated 11 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago