GRgreenhouse
Departments

Update department

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.

patch/v3/departments/{id}

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/departments/{id}
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:departments:update
    • or HTTP bearer

Path parameters

idinteger required

Request body

namestring required

New display name for the department. Required.

parent_idinteger nullable

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.

external_idstring nullable

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.

external_parent_idstring nullable

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.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
namestring

Display name of the department (e.g. Engineering, Marketing).

parent_idinteger nullable

Id of the parent department in the organization's department tree. null for top-level departments. References another /v3/departments row.

external_idstring nullable

Partner-supplied identifier for the department, typically the matching id from an HRIS or other external system. Free-form string and null when no external id has been set.

external_parent_idstring nullable

external_id of the parent department, for partners that key the department hierarchy by external id rather than Greenhouse id. Mirrors the external_parent_id accepted on create and update. null for top-level departments and when the parent has no external id set.

Changes

No recorded changes to this operation across all 1 revision of this API.