Appearance
Update a candidate
PUT
/api/nova/candidates/{candidateId}
Applies a partial update to an existing candidate. Text fields are only overwritten when supplied (name and email additionally ignore blank values), while skills, tags, education history, employment history, and custom fields are replaced wholesale when present in the body. The workPermit, rightToWork and doNotContact booleans, the address object (street, city, state, country, postcode) and the expected salary fields (desiredSalary, desiredSalaryCurrency, desiredSalaryTenure, noticePeriod) are only applied when supplied. Returns the candidate ID on success, 404 if the candidate does not exist, 401 for an invalid API key, and 429 when rate limited.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "address": { "city": "string", "country": "string", "postcode": "string", "state": "string", "street": "string" }, "alternateEmail": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "desiredSalary": 0, "desiredSalaryCurrency": "string", "desiredSalaryTenure": "string", "doNotContact": true, "educationHistory": [ { "educationLevelId": "string", "endYear": 0, "grade": "string", "major": "string", "organisation": "string", "startYear": 0 } ], "email": "string", "employmentHistory": [ { "companyName": "string", "employmentTypeId": "string", "endDate": "string", "jobTitle": "string", "startDate": "string", "workSummary": "string" } ], "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "noticePeriod": "string", "overview": "string", "ownerId": "string", "rating": 0, "rightToWork": true, "skills": [ "string" ], "sourceId": "string", "statusId": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "workPermit": true, "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}