GRgreenhouse
Custom Field Options

Delete custom field option

Archive a custom field option so it can no longer be selected on new records. Deletes are soft: the row stays in the database with active: false, historical selections on candidates, jobs, and offers are preserved, and the option still appears in list responses unless the caller passes active=true. To restore an archived option, POST a new option with the original name. Deleting an option that is already archived succeeds and changes nothing, so retries and repeated ids within a bulk batch are safe.

delete/v3/custom_field_options/{id}

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/custom_field_options/{id}
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:custom_field_options:destroy
    • or HTTP bearer

Path parameters

idstring required

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
messagestring

Changes

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