API Reference

Update department

patch
https://harvest.greenhouse.io/v3/departments/

Update an existing department's name, external_id, or position in the department tree. Use parent_id (or external_parent_id) to re-parent the department; both are optional on update and the existing parent is preserved when neither is supplied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
required
length ≤ 255

New display name for the department. Required.

integer | null

Id of an existing department to set as the new parent. Set to null to remove the parent. Use parent_id when you already have the Greenhouse id; use external_parent_id to reference the parent by its external id instead.

string | null

Partner-supplied identifier for the department, typically the matching id from an HRIS or other external system. Set to null to clear the existing external_id.

string | null

external_id of an existing department to set as the new parent. Set to null to remove the parent. Useful when you only have external ids on hand; ignored if parent_id is also supplied.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Updated 3 months ago

Did this page help you?
Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?