Update User

Edit a user's basic information in Greenhouse.

Options

Field	Definition	Type	Required
Update By	Choose one option to identify the user record. There are three options: User ID: The Greenhouse user ID Email: The email address that is stored in Greenhouse for the user Employee ID: The user's employee ID, if available Any of the email addresses assigned to the user's account can be used for the look up action. However, an email address can't be included in more than one user account.	Dropdown	TRUE
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

Update By

Choose one option to identify the user record. There are three options:

User ID: The Greenhouse user ID
Email: The email address that is stored in Greenhouse for the user
Employee ID: The user's employee ID, if available

Any of the email addresses assigned to the user's account can be used for the look up action. However, an email address can't be included in more than one user account.

Dropdown

TRUE

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

Field	Definition	Type	Required
On Behalf Of
User ID	ID of the user issuing this request. Required for auditing purposes.	Number	TRUE
User	The User section displays only one of these fields, based on the selection in the Update By option.
ID	Unique identifier of the user.	Number	TRUE
Email	Any of the email addresses associated with this user.	Text	TRUE
Employee ID	Unique external ID of the user.	Text	TRUE
Update
First Name	Given name of the user. If selected, this field can't be left blank.	Text	FALSE
Last Name	Family name of the user. If selected, this field can't be left blank.	Text	FALSE
Employee ID	Unique external ID of the user.	Text	FALSE
Office IDs	The user's new offices. If this option is selected, 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	This may be used instead of Office IDs. Each number represents the ID of an office in an external system. If this option is selected, then Office IDs must be blank.	List of Numbers	FALSE
Department IDs	The user's new departments. If this option is selected, 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	This may be used instead of Department IDs. Each number represents the ID of a department in an external system. If this option is selected, then Department IDs must be blank.	List of Numbers	FALSE
Custom Fields	A list of custom field objects that contain all the custom fields to update for this user. Each object needs to strictly follow the format mentioned in the Custom Field Parameters section of the Edit User API documentation.	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 User

Options

Input

Output

Related topics