Update Candidate

Edit a candidate's basic information in Greenhouse.

Options

Field	Definition	Type	Required
Pass Empty Values?	Specifies whether empty values are passed to the remote system, instead of skipping an update to the field. `Yes`: For any input field on the card that is blank or given a null value, the update includes the empty field. This clears any existing value on the remote system for that field. `No`: For any input field on the card that is blank or given a null value, nothing is sent to the remote system for this field. Any existing value on the remote system remains unchanged. Note: This option also affects lists or objects, but doesn't affect dropdown types. Note: If you set Pass Empty Values? to `Yes` and you select all three fields (First Name, Last Name, Email Addresses), all three fields can't be empty. At least one must have a value.	Dropdown	FALSE

Input

Field	Definition	Type	Required
Candidate
ID	Unique identifier of this candidate.	Number	TRUE
First Name	The candidate's new given name.	Text	FALSE
Last Name	The candidate's new family name.	Text	FALSE
Preferred Name	The candidate's preferred name.	Text	FALSE
Timezone	The candidate's new time zone.	Dropdown	FALSE
Company	The candidate's new company.	Text	FALSE
Title	The candidate's new title.	Text	FALSE
Is Private	Select true if the candidate profile is private.	True/False	FALSE
Can Be Emailed	Candidate can be emailed.	True/False	FALSE
Phone Numbers	Array of the candidate's phone numbers. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Objects	FALSE
Addresses	Postal addresses on the candidate's profile. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Objects	FALSE
Email Addresses	Array of the candidate's email addresses. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Objects	FALSE
Website Addresses	Array of the candidate's website addresses. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Objects	FALSE
Social Media Addresses	Array of the candidate's social media addresses. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Objects	FALSE
Tags	Array of the candidate's tags. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Text	FALSE
Linked User IDs	Greenhouse user IDs linked to the candidate if they're an internal applicant. Passing an empty array clears all values if Pass Empty Values? is set to `Yes`.	List of Numbers	FALSE
Custom Fields	A list of custom field objects that contain all the custom fields to update for this candidate. Note: Each object needs to strictly follow the format mentioned in the Custom Field Parameters section of the Update Candidate API documentation.	List of Objects	FALSE

Output

Field	Definition	Type
Basic Information
ID	Unique identifier of the candidate.	Number
First Name	Given name of the candidate.	Text
Last Name	Family name of the candidate.	Text
Preferred Name	Preferred name of the candidate.	Text
Timezone	Timezone of the candidate. Note: The output of this field can't be used in input of other candidate card.	Text
Company	The company where the candidate currently works.	Text
Title	The candidate's current title.	Text
Created At	Date and time when the candidate profile was created. This value is in ISO-8601 format.	Date & Time
Updated At	Date and time when the candidate profile was updated. This value is in ISO-8601 format.	Date & Time
Last Activity At	Date and time when the candidate was last active. This value is in ISO-8601 format.	Date & Time
Is Private	If true, the candidate is restricted to users with View Private Candidates access.	True/False
Phone Numbers	Array of the candidate's phone numbers.	List of Objects
Addresses	Array of the candidate's postal addresses.	List of Objects
Email Addresses	Array of the candidate's email addresses.	List of Objects
Website Addresses	Array of the candidate's website addresses.	List of Objects
Social Media Addresses	Array of the candidate's social media addresses.	List of Objects
Can Be Emailed	Returns true if the candidate can be emailed.	True/False
Tags	Array of the candidate's tags.	List of Text
Linked User IDs	Greenhouse user IDs that are linked to the candidate if they're an internal applicant.	List of Numbers
Custom Fields
Custom fields for candidate records.	Based on the actual custom field definitions.	Depends on the actual custom field types
All Custom Fields	All custom fields of this candidate.	Object

This card has 30 individual fields listed under the Custom Fields output group so you can retrieve those popular custom fields easily.

These 30 custom fields returned are the top 30 custom fields in the order that's shown on your Candidates Custom Options configuration page. It's also the same order as the custom fields that are shown on the information page when editing a specific candidate.

Note:

If you have over 500 existing custom fields, and manually move a field from a position above 500 to within the first 30 fields, it may not be included in the 30 custom field outputs. In this case, you can use the Object.Get function card to locate any custom field from within the All Custom Fields output.

The School Name, Degree, and Discipline don't appear on your Candidates Custom Options configuration page. The system configures these three fields by default and so they aren't returned inside the custom_fields payload from the Read Candidate endpoint.