Sign in

v1

latestOpenAPI 3.1.02026-07-26167644759.4 KB
Candidates

Update a candidate

Updates the candidate with the specified ID. Only provided fields are updated. You can update personal details, contact information, and other candidate attributes.

patch/candidates/{id}

Path parameters

idstring required

Request body

firstNamestring

The first name of the candidate

middleNamestring

The middle name of the candidate

lastNamestring

The last name of the candidate

secondLastNamestring

The second last name of the candidate (common in Spanish-speaking countries)

gender'male' | 'female' | 'x' nullable

The gender of the candidate

nationalityECandidateNationality[]

The nationalities of the candidate

statusECandidateStatus[]

The current status(es) of the candidate in the recruitment process

acquisitionSource'manual' | 'cv_parse' | 'inbound_vacancy_portal' | 'inbound_spontaneous_application' | 'chrome_extension_linkedin' | 'inbound_from_linkedin_jobboard_email' | 'inbound_from_external_jobboard' | 'juicebox' | 'pin' | 'maildrop' | 'csv_import' | 'vdab' | 'advertsdata' nullable
visibleIfClientContactboolean nullable

Whether this candidate should be visible when they are also a client contact

dateOfBirthstring date-time
lastInteractionAtstring date-time
lastInteractionWithIdstring nullable

The user ID of the person who last interacted with the candidate

Example request

{
  "firstName": "John",
  "middleName": "William",
  "lastName": "Doe",
  "secondLastName": "Garcia",
  "lastInteractionWithId": "user-uuid-here"
}

Response

Candidate updated successfully

idstring required
createdAtstring date-time required
modifiedAtstring date-time required
lastActivityDatestring date-time required
aiSummarystring nullable required
isVisibleIfClientContactboolean nullable required
hasClientContactsboolean required
hasActiveClientContactsboolean required