Update opening

patch

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

Patch an existing opening's editable fields, or change its status. Only the keys included in the request body are modified; omitted keys are left unchanged. Pass status: "closed" to close an open opening. Include close_reason_id when closing if your organization requires one. Closing the last open opening on a job automatically closes the job. Pass status: "open" to reopen a closed opening that has not been filled; reopening a filled opening returns 422. custom_fields replaces the opening's custom-field values wholesale, so send the full desired list, not a delta.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Body Params

job_id

integer

Id of the job (requisition) this opening belongs to. Provided to disambiguate the opening; reassigning an opening to a different job is not supported.

opening_id

string

length ≤ 255

Partner-supplied external identifier for the opening (e.g. an HRIS or ATS position id). Free-form string, not required to be unique across the organization.

close_reason_id

integer

ID of the close_reason to record when closing the opening, for example Hire - New Headcount, On Hold, or Requisition Cancelled. Resolve via GET /v3/close_reasons. On an open opening, supplying close_reason_id without also setting status to closed returns 422; on an already-closed opening, close_reason_id can be updated on its own.

status

string

enum

Transition the opening's lifecycle. Pass closed to close an open opening (optionally with close_reason_id); pass open to reopen a closed opening that has not been filled.

Allowed:

target_start_on

date

Target start date for the hire that will fill this opening, in ISO 8601 (YYYY-MM-DD).

custom_fields

array of objects

Values to set on this opening's opening custom fields. Each entry identifies the field by custom_field_id or name_key and supplies a value whose shape matches the field's value_type (see GET /v3/custom_fields?field_type=opening). Replaces the existing values wholesale — send the full desired list, not a delta.

custom_fields

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