Update user

patch

https://harvest.greenhouse.io/v3/users/{id}

Patch an existing user's profile fields. Only the keys included in the request body are modified; all other fields are left unchanged. Array assignments (office_ids, department_ids, interviewer_tag_ids) fully replace the existing set — pass an empty array to clear it. A primary_email update is only accepted when the new value is already a verified email address on the user's account. To toggle activation, site admin status, or job-level permissions, use the dedicated endpoints (activate, deactivate, revoke_permissions, /v3/user_job_permissions) rather than this one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Body Params

first_name

string

length ≤ 255

last_name

string

length ≤ 255

primary_email

string

New primary email for the user. Must already be a verified email address on the user's account — call the V1/V2 endpoint to add and verify a new email address before promoting it here.

job_title

string

length ≤ 255

New job title for the user's Greenhouse profile.

employee_id

string

length ≤ 255

Partner-supplied external employee identifier (typically the user's HRIS or payroll id) to set on the user.

office_ids

array of integers

Greenhouse office ids to pin the user to. Replaces the user's current office assignments. Mutually exclusive with external_office_ids.

office_ids

external_office_ids

array of strings

External office identifiers (the offices' external_id) to pin the user to. Replaces the user's current office assignments. Mutually exclusive with office_ids.

external_office_ids

department_ids

array of integers

Greenhouse department ids to pin the user to. Replaces the user's current department assignments. Mutually exclusive with external_department_ids.

department_ids

external_department_ids

array of strings

External department identifiers (the departments' external_id) to pin the user to. Replaces the user's current department assignments. Mutually exclusive with department_ids.

external_department_ids

interviewer_tag_ids

array of integers

Ids of interviewer tags to apply to the user. Replaces the user's current set of interviewer tags.

interviewer_tag_ids

custom_fields

array of objects

custom_fields

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful