Update Candidate

Updates details for an existing candidate

Request Details

path Parameters

Field	Type	Required	Description
id	string	Yes	The unique identifier of the candidate

body Parameters

Field	Type	Required	Description
organizationId	string	Yes	ID of the organization that owns the candidate record
memberId	string	Yes	ID of the org's member who added or owns the candidate
name	string	Yes	Full name of the candidate
firstName	string	No	First name of the candidate (optional override of parsed name)
lastName	string	No	Last name of the candidate (optional override of parsed name)
email	string	Yes	Email address of the candidate
phone	string	No	Phone number of the candidate
profiles	array CandidateProfile	Yes	List of public or social profiles associated with the candidate

Sample Request & Response

PATCH

/candidates/{id}

Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Path Parameters:

{
  "id": "string (required) - The unique identifier of the candidate"
}

Body:

{
  "organizationId": "example_string",
  "memberId": "example_string",
  "name": "example_string",
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "profiles": [
    {
      "network": "example_string",
      "username": "example_string",
      "url": "example_string"
    }
  ]
}

Sample Response (200)

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "organizationId": "example_string",
  "memberId": "example_string",
  "name": "example_string",
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "profiles": [
    {
      "__id": "example_string",
      "network": "example_string",
      "username": "example_string",
      "url": "example_string"
    }
  ]
}