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. This option also affects lists or objects, but doesn't affect dropdown types. If you set Pass Empty Values? to Yes, then the First Name and Last Name fields can't be left blank if you select them as inputs.	Dropdown	TRUE

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.

This option also affects lists or objects, but doesn't affect dropdown types.

If you set Pass Empty Values? to Yes, then the First Name and Last Name fields can't be left blank if you select them as inputs.

Dropdown

TRUE

Input

All JSON objects (including those in a list of objects) need to strictly follow the format outlined in the Custom Field Parameters section of the Edit Candidate API documentation.

Always use lowercase text for any key names.

Field	Definition	Type	Required
On Behalf Of
User ID	ID of the user issuing this request. Required for auditing purposes.	Number	TRUE
Candidate
ID	Unique identifier of this candidate.	Number	TRUE
Update
First Name	The candidate's new given name. If selected, this field can't be left blank.	Text	FALSE
Last Name	The candidate's new family name. If selected, this field can't be left blank.	Text	FALSE
Company	The candidate's new company.	Text	FALSE
Title	The candidate's new title.	Text	FALSE
Is Private	Select true if the user is private.	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	Array of the candidate's physical addresses. 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
Recruiter	An object representing the candidate's new recruiter. Either the recruiter's ID or email address must be present.	Object	FALSE
Coordinator	An object representing the candidate's new coordinator. Either the coordinator's ID or email address must be present.	Object	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
Custom Fields	An object containing all the custom fields that are to be updated for this candidate.	List of Objects	FALSE

Output

Field	Definition	Type
Response
Status Code	Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example: A 201 Created status code indicates success where a new resource was created. A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing. For a full list of possible status codes, see HTTP status codes.	Number

Field

Definition

Type

Response

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

A 201 Created status code indicates success where a new resource was created.
A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Update Candidate

Options

Input

Output

Related topics