Update candidate personal information

patch https://api.smartrecruiters.com/candidates/{id}

Update candidate details

Responses

Response body

object

string

internal

boolean

firstName

string

lastName

string

phoneNumber

string

location

object

country

string

length ≥ 1

countryCode

string

length between 2 and 2

regionCode

string

region

string

city

string

length ≥ 1

lat

float

lng

float

web

object

skype

string

facebook

string

twitter

string

website

string

createdOn

date-time

updatedOn

date-time

tags

averageRating

number

deprecated

education

array of objects

education

object

institution

string

length ≥ 1

degree

string

length ≥ 1

major

string

length ≥ 1

current

boolean

location

string

startDate

string

date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"

endDate

string

date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"

description

string

experience

array of objects

experience

object

title

string

length ≥ 1

company

string

length ≥ 1

current

boolean

startDate

string

date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"

endDate

string

date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"

location

string

description

string

primaryAssignment

object

Its latest modified application from applications in non final-state. If no applications in non-final state then one in final state with most recent modification date is returned. Inactive(final) states are Lead, Rejected, Transferred, Withdrawn, Hired

job

object

status

string

LEAD NEW IN_REVIEW INTERVIEW OFFERED HIRED REJECTED WITHDRAWN TRANSFERRED

subStatus

string

startsOn

date-time

source

string

reasonOfRejection

object

reasonOfWithdrawal

object

actions

object

secondaryAssignments

array of objects

List of assignemnts (applications). Applications are sorted by state (non-final states first) and then by date. First one is excluded and is returned as primaryAssignment. Mentioned date is a date of last modification of an application eg: changed state, change of a source, reapply, anonymisation, unshare. Inactive(final) states are Lead, Rejected, Transferred, Withdrawn, Hired

secondaryAssignments

object

job

object

status

string

LEAD NEW IN_REVIEW INTERVIEW OFFERED HIRED REJECTED WITHDRAWN TRANSFERRED

subStatus

string

startsOn

date-time

source

string

reasonOfRejection

object

reasonOfWithdrawal

object

actions

object

actions

object

properties

object

required

attachments

object

consent

object

consents

object

Language

Credentials


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.smartrecruiters.com/candidates/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Candidate updated

403with code PERMISSION_DENIED when you are not permitted to update candidate details

404with code: CANDIDATE_NOT_FOUND when candidate not found

409with code CANDIDATE_DATA_CONFLICT when you try to update a candidate's e-mail or last name to one that is already owned by another candidate. The combination of e-mail and last name is unique in the system, you cannot have two candidates with the same e-mail address and last name.