Update User

Edit a user'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.
 Dropdown TRUE

Input

Field Definition Type Required

User

ID

Unique identifier of the user. Number TRUE

Update

First Name

Given name of the user. Text FALSE

Last Name

Last name of the user. Text FALSE

Employee ID

Unique external ID of the user. Text FALSE

Job Title

Job title of the user.

 Text FALSE

Office IDs

The user's new offices.

If you select this option, then External Office IDs must be blank.

An empty array removes all offices for this user if Pass Empty Values? is set to Yes.

 List of Numbers FALSE

External Office IDs

You can use this field instead of Office IDs. Each number represents the ID of an office in an external system.

If you select this option, then Office IDs must be blank.

 List of Text FALSE

Department IDs

The user's new departments.

If you select this option, then External Department IDs must be blank.

An empty array removes all departments for this user if Pass Empty Values? is set to Yes.

 List of Numbers FALSE

External Department IDs

You can use this field instead of Department IDs. Each number represents the ID of a department in an external system.

If you select this option, then Department IDs must be blank.

 List of Text FALSE

Interviewer Tag IDs

The user's new interviewer tags.

An empty array removes all interviewer tags for this user 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 user.

 List of Objects FALSE

Output

Field Definition Type

Basic Information

ID

Unique identifier of the user. Number

Name

Name of the user. Text

First Name

Given name of the user. Text

Last Name

Last name of the user. Text

Primary Email Address

The email address that this user designated as their primary address.

 Text

Updated At

Date and time when the object was updated. Date & Time

Created At

Date and time when the object was created. Date & Time

Job Title

Returns the job title that's associated with the user.

 Text

Deactivated

Returns true if the user is deactivated.

 True/False

Site Admin

Returns true if the user is a site administrator.

 True/False

Employee ID

Unique external ID of the user. Text

Agency ID

Unique identifier of the agency that's associated with the user.

 Text

Linked Candidate IDs

Contains the IDs of candidate records containing this user's personal applications. These are the records containing this user's personal interview records and other information.

 List of Numbers

Offices IDs

The IDs of offices that are associated with the user.

 List of Numbers

Departments IDs

The IDs of departments that are associated with the user.

 List of Numbers

Interviewer Tags

An array containing Id and Name of the interviewer tags that are associated with this user.

 List of Objects

Custom Fields

Custom fields for user records

Based on the actual custom field definitions.

Depends on the actual custom field types

All Custom Fields

All custom fields of this user.

 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 Users Custom Options configuration page. It's also the same order as the custom fields that are shown on the user information page when editing a specific user.