v1

latestOpenAPI 3.0.12026-08-063985821.3 MB

Candidate API:Candidates

Update a candidate

put/candidates/{candidateId}

Path parameters

candidateIdinteger required

Headers

X-Allow-Duplicatesstring

Duplicate override code from the header of an earlier 409 response

Request body

firstNamestring nullable

lastNamestring nullable

emailstring nullable

phonestring nullable

mobilestring nullable

salutationstring nullable

Salutation/honorific/title

statusIdinteger nullable

Candidate status

ratingstring nullable

seeking'Yes' | 'Maybe' | 'No' string

unsubscribedboolean

summarystring nullable

dateOfBirthstring date nullable

emergencyContactstring nullable

emergencyPhonestring nullable

socialobject nullable

skillTagsstring[] nullable

recruiterUserIdinteger[] nullable

customSkillsstring[] nullable

A maximum of 500 custom skills can be submitted per request

Example request

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/",
    "youtube": "https://www.youtube.com/c/jobadder",
    "other": "https://jobadder.com/company/"
  },
  "custom": [
    {
      "fieldId": 1,
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "value": [
        "List value 1",
        "List value 2"
      ]
    },
    {
      "fieldId": 3,
      "value": "2018-07-01"
    }
  ]
}

Response

Candidate was successfully updated