Update office

patch

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

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Body Params

name

string

required

length ≤ 255

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

parent_id

integer | null

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_id

string | null

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

location

string | null

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

primary_in_house_contact_user_id

integer | null

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_id

string | null

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.

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