GRgreenhouse
Custom Field Departments

Create custom field department

Restrict a custom field's visibility to one additional department. Each call adds one (custom_field_id, department_id) pair; repeat the call for each department the field should appear under. Once any custom_field_department rows exist for a field, it stops being visible to departments outside the list.

post/v3/custom_field_departments

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/custom_field_departments
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:custom_field_departments:create
    • or HTTP bearer

Request body

custom_field_idinteger required

Id of the custom field to scope. The field becomes visible only on jobs, offers, or candidates whose department matches one of the field's custom_field_departments rows.

department_idinteger required

Id of the department to grant visibility to. Must belong to the same organization as the custom field.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
custom_field_idinteger

Id of the custom field whose visibility is being scoped. References a /v3/custom_fields row.

department_idinteger

Id of the department the custom field is restricted to. References a /v3/departments row.

Changes

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