Update a Candidate

Time	Status	User Agent
Retrieving recent requests…

Supported Apps

Here are the list of apps that support this API.

Ashby (ashby)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - the value at 0th index is considered as primaryEmail and the values at 1st index is considered as a alternateEmail.
links[].platform - one of LINKEDIN GITHUB WEBSITE TWITTER
links[].link
tags - expects list of tagId's as input - to get the tha tagId, you can use get global tags, or get candidate tags api.
presentAddress.city
presentAddress.state
presentAddress.country
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required
attachments[].fileContent
attachments[].fileUrl - One Of fileContent or fileUrl is Required
attachments[].contentType - Required if fileContent is given
metaData

Lever (lever)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].type - one of WORK PERSONAL SKYPE OTHERS
phones[].phoneNumber
emails[].email
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode - all the address fields are appended as a single string and sent as location to lever
metaData

SuccessFactors ATS (successfactors-ats)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].type - WORK
emails[].email - Knit sends the first WORK-type email in the list as contactEmail and the first non-WORK email as primaryEmail. Only these two emails are honored.
title
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state - give a vallid state name
presentAddress.country - expects a 2 letter country code like US , CA etc.
presentAddress.zipCode
education[].institute
education[].fromDate
education[].toDate
attachments[].fileType - one of RESUME COVER_LETTER OTHERS
attachments[].fileName
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

TeamTailor (teamtailor)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at the 0th index is honored.
links[].platform - supported LINKEDIN
links[].link
tags
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required if fileContent is given
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

UKG Pro Recruiting (ukgpro-ats)

Supported Request Fields:

education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major - expects id of the major
education[].minor - expects id of the minor (both major and minor ids can be obtained using passthrough request with method - GET, path - /api/fields-of-study)
education[].description
skills[].name
skills[].level - expects id of the proficiency_level - can be obtained using passthrough request with method - GET, path - /api/proficiency-levels
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].summary
attachments[].fileType - every type is uploaded as a generic candidate document to UKG Pro Recruiting.
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType - Required if you are giving fileContent and not a fileUrl

Remarks: The above details gets appended to the existing data of the Candidate.

Vincere (vincere)

Supported Request Fields:

candidateId - Required
firstName - Required
lastName - Required
phones[].type - one of WORK HOME OTHERS
phones[].phoneNumber
emails[].type - one of WORK OTHERS
emails[].email - at least one email is Required.
links[].platform - one of LINKEDIN FACEBOOK TWITTER WEBSITE
links[].link
company
workAddress.addressLine1
workAddress.addressLine2
workAddress.city
workAddress.state
workAddress.country
workAddress.zipCode - all the workAddress fields are appended together and sent as company location name.
permanentAddress.addressLine1
permanentAddress.addressLine2
permanentAddress.city
permanentAddress.country
permanentAddress.zipCode - all the permanentAddress fields are appended together and sent as personal location name.
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode - all the presentAddress fields are appended together and sent as current location name.
education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major
education[].minor
education[].description
education[].score
skills[].name
skills[].level - one of BEGINNER INTERMEDIATE ADVANCED FLUENT NATIVE
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary
attachments[].fileType
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData
metaData.candidate_source_id - Required - Can be obtained using the passthrough request
metaData.document_type_id - Required Only If you are adding attachments - Can be obtained using the passthrough request

Workable (workable)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at 0th index is honored.
title
links[].platform - one of FACEBOOK GITHUB LINKEDIN STACKOVERFLOW TWITTER BLOG
links[].link
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode - all the presentAddress fields are appended together and sent as address string.
education[].degree
education[].institute
education[].id
education[].fromDate
education[].toDate
education[].major - this list replaces the existing education list completely.
skills[].name
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary - this list replaces the existing experiences list completely.
attachments[].fileType - supported values RESUME OTHERS (the OTHERS are added as a comment with a attachment.)
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

Remarks : Candiates that are created into a talent pool are not updatable using this API, only the candidates that are associated with a job are updatable using this API.

Zoho Recruit (zoho-recruit)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - value at 0th, 1st, 2nd indices are honored as Mobile, Phone, Fax respectively.
emails[].email - the value at 0th and 1st index are honored as Email and Secondary_Email respectively.
title
company
links[].platform - one of LINKEDIN FACEBOOK TWITTER PERSONAL_WEBSITE
links[].link
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
education[].degree
education[].institute
education[].fromDate
education[].id - if given only that instance is updated else education gets appended to the existing education list.
education[].toDate
education[].major
education[].currentlyPursuing
skills[].name
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary - the experience objects gets appended to the existing experience list.
attachments[].fileType - one of RESUME COVER_LETTER OTHERS
attachments[].fileName
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

iCIMS (icims)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].type - one of WORK PERSONAL OTHERS
phones[].phoneNumber
emails[].email - only the value at the 0th index is honored.
workAddress.addressLine1
workAddress.addressLine2
workAddress.city
workAddress.state
workAddress.country
workAddress.zipCode
permanentAddress.addressLine1
permanentAddress.addressLine2
permanentAddress.city
permanentAddress.country
permanentAddress.zipCode
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
attachments[].fileType - Supported type - RESUME
attachments[].fileName - Required (Only If you are sending attachments)
attachments[].fileContent
attachments[].fileUrl - One of fileUrl or fileContent is Required.
attachments[].contentType - Required If you are giving fileContent
metaData - metaData.candidateRoleId is Required, Default to the value D32007

Jobvite (jobvite)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].type - one of HOME WORK OTHERS
phones[].phoneNumber
emails[].email - only the value at the 0th index is honored and Required.
title
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
metaData

Loxo (loxo)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at the 0th index is honored.
title
company
links[].platform - one of LINKEDIN WEBSITE
links[].link
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
education[].degree
education[].institute
education[].fromDate
education[].description
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required (Only If you are sending attachments)
attachments[].fileContent
attachments[].fileUrl - one of fileUrl or fileContent is Required
attachments[].contentType - Required if you are giving fileContent
metaData

Recruit CRM ATS (recruit-crm-ats)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber
emails[].email - only the value at the 0th index is honored.
title
company
links[].platform - one of LINKEDIN FACEBOOK TWITTER GITHUB XING
links[].link
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major
education[].description
education[].score
skills[].name
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required (Only If you are sending attachments)
attachments[].fileContent - only supported for fileType == RESUME
attachments[].fileUrl - Required if the fileType == OTHERS
attachments[].contentType - Required if you are giving fileContent
metaData

Oracle HCM ATS (oracle-hcm-ats)

Supported Request Fields:

candidateId - Required
firstName
lastName
emails[].email - only the value at the 0th index is honored.
metaData

Pinpoint (pinpoint)

Supported Request Fields:

candidateId - Required
firstName
lastName
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at the 0th index is honored.
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.country
presentAddress.zipCode
attachments[].fileName
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

Supported Apps

200

400Bad Request