GRgreenhouse
Offices

Update office

Update an existing office. Any subset of name, location, external_id, parent_id (or external_parent_id), and primary_in_house_contact_user_id may be supplied; fields that are omitted are left unchanged. Re-parenting via parent_id and external_parent_id is mutually exclusive — pass one or the other, never both.

patch/v3/offices/{id}

Request

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

Path parameters

idinteger required

Request body

namestring required

New display name for the office. Must remain unique among active offices in the organization.

parent_idinteger nullable

Id of the office to set as the new parent in the office hierarchy. Pass to re-parent the office; set to null to remove the parent. Mutually exclusive with external_parent_id.

external_idstring nullable

Customer- or HRIS-supplied identifier for cross-system reconciliation. Set to null to clear. Requires the org_structure_external_id product flag.

locationstring nullable

Free-form physical location string for the office (e.g. New York, NY, USA). Set to null to clear.

primary_in_house_contact_user_idinteger nullable

Id of the Greenhouse user to set as the office's primary internal contact. Set to null to clear. References a /v3/users row.

external_parent_idstring nullable

external_id of the office to set as the new parent, for partners that key the hierarchy by external id rather than Greenhouse id. Set to null to remove the parent. Mutually exclusive with parent_id.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
namestring

Display name of the office (e.g. San Francisco, Remote (US)). Unique among active offices in the same organization.

parent_idinteger nullable

Id of the parent office when offices are organized hierarchically. null for top-level offices. References another /v3/offices row in the same organization.

external_idstring nullable

Stable identifier supplied by the customer or HRIS for cross-system reconciliation. null when no external id has been set. Available when the org_structure_external_id product flag is enabled.

external_parent_idstring nullable

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

locationstring nullable

Free-form physical location string for the office (e.g. New York, NY, USA). null for offices that have no location set, including most remote offices.

primary_in_house_contact_user_idinteger nullable

Id of the Greenhouse user designated as the office's primary internal contact, typically the local recruiting lead. References a /v3/users row. null when no contact has been assigned.

Changes

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