GRgreenhouse
Custom Field Options

Bulk update custom field options

Asynchronously edit the label, sort order, or external id of many options in one call — most often used to reorder a dropdown after an upstream HRIS reshuffle or to rename options en masse. Each item must include id; the remaining fields are treated as a partial update. Per-item success or failure is reported through the bulk-status endpoint.

patch/v3/custom_field_options/bulk

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/custom_field_options/bulk
  • Auth
    OAuth 2
    Authorization code: https://auth.greenhouse.io/authorize
    Client credentials
    Token URL: https://auth.greenhouse.io/token scopes: harvest:custom_field_options: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.