Update candidate

Patch an existing candidate's profile fields. Only the keys included in the request body are modified; omitted keys are left untouched. Array fields (phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, tags, linked_user_ids, custom_fields) replace the existing collection wholesale — send the full desired list, not a delta. Setting is_private to true restricts the candidate to users with View Private Candidates access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
length ≤ 255
string
length ≤ 255
string
length ≤ 255
string
enum
string
string
length ≤ 255
boolean
boolean
phone_numbers
array of objects
phone_numbers
addresses
array of objects
addresses
email_addresses
array of objects
email_addresses
website_addresses
array of objects
website_addresses
social_media_addresses
array of objects
social_media_addresses
tags
array of strings
tags
linked_user_ids
array of integers
linked_user_ids
custom_fields
array of objects
custom_fields
Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json