Update job

Patch an existing job's editable fields. Only the keys included in the request body are modified; omitted keys are left untouched. office_ids / external_office_ids and custom_fields replace their existing collections wholesale — send the full desired list, not a delta. Department and office can be set either by Greenhouse id or by partner external_id; the two forms are mutually exclusive. To open, close, or re-open a job, modify its openings through /v3/openings — the job's status and opened_at/closed_at follow automatically.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string

Internal job title shown to the hiring team in Greenhouse.

string

Internal HTML notes about the job. Replaces the existing value when supplied.

boolean | null

If true, the job is marked as remote-anywhere and office_ids is cleared. Mutually exclusive with supplying office_ids or external_office_ids.

string | null

Partner-supplied external identifier for the requisition. Pass null to clear the value.

string

Internal description of the team and the role's responsibilities, shown to the hiring team in the Greenhouse UI.

string

Internal selling-points note used by recruiters when pitching the role, shown to the hiring team in the Greenhouse UI.

office_ids
array of integers | null

Replace the job's office assignments with these office ids. Send the full desired list, not a delta. Mutually exclusive with external_office_ids and with anywhere: true.

office_ids
external_office_ids
array of strings | null

Replace the job's office assignments by partner-supplied office external_id values. Each entry is resolved to a Greenhouse office_id in the caller's organization; unknown values are rejected. Mutually exclusive with office_ids.

external_office_ids
integer | null

Set the job's department by Greenhouse id. Pass null to clear. Mutually exclusive with external_department_id.

string | null

Set the job's department by partner-supplied department external_id. Resolved to a Greenhouse department_id in the caller's organization; unknown values are rejected. Mutually exclusive with department_id.

custom_fields
array of objects

Values to set on this job's job custom fields. Replaces the existing collection wholesale — send the full desired list, not a delta. Each entry identifies the field by custom_field_id or name_key and supplies a value matching the field's value_type.

custom_fields
Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json