Create office

post

https://harvest.greenhouse.io/v3/offices

Create a new office for the organization. Provide a name and, optionally, a location, an external_id, a primary_in_house_contact_user_id, and a parent reference (either parent_id or external_parent_id, not both). Tiered offices require the tiered_offices_and_departments product flag; external_id requires the org_structure_external_id product flag.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 255

Display name of the new office. Must be unique among active offices in the organization.

parent_id

integer

Id of the office to use as the parent in the office hierarchy. Omit (or set with external_parent_id instead) when creating a top-level office. Mutually exclusive with external_parent_id.

external_id

string

length ≤ 255

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

location

string

length ≤ 255

Free-form physical location string for the office (e.g. New York, NY, USA). Optional; omit for remote-only offices.

primary_in_house_contact_user_id

integer

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

external_parent_id

string

length ≤ 255

external_id of the office to use as the parent, for partners that key the hierarchy by external id rather than Greenhouse id. 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

201Successful