GRgreenhouse
Departments

Bulk update departments

Asynchronously update many departments in a single request. Each item in data accepts the same fields as PATCH /v3/departments/{id} and must include the department's id. The request returns 202 Accepted with a bulk_action_uuid; poll /v3/bulk_requests/{bulk_action_uuid} for status and per-record success/failure files.

patch/v3/departments/bulk

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/departments/bulk
  • Auth
    OAuth 2
    Authorization code: https://auth.greenhouse.io/authorize
    Client credentials
    Token URL: https://auth.greenhouse.io/token scopes: harvest:departments:update

Request body

callback_urlstring

Optional HTTPS URL Greenhouse will POST to when every row in data has finished. Omit to poll GET /v3/bulk_requests/{bulk_action_uuid} instead.

Response

Accepted

bulk_action_uuidstring

UUID assigned to the new bulk request. Use this with GET /v3/bulk_requests/{bulk_action_uuid} to monitor progress and retrieve per-row results.

statusstring

Initial lifecycle state of the new bulk request, typically building immediately after creation. See the bulk request response schema for the full set of values.

status_urlstring

Relative path that returns the current status of the bulk request. Append this to your Harvest base URL to fetch the latest state.

Changes

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