Create custom field

post

https://harvest.greenhouse.io/v3/custom_fields

Add a new custom field to your organization's dictionary. name, field_type, and value_type are required. The request body shape varies by field_type — job, offer, opening, and user_attribute accept type-specific properties (e.g. require_approval for job/opening fields, trigger_new_version for offer fields). For single_select and multi_select fields, supply the initial option list inline via custom_field_options; after creation, manage options through /v3/custom_field_options.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 255

Human-readable label for the new field. Must be unique among active fields of the same field_type.

value_type

string

enum

required

Data type and editor for the field. Determines which payload shape parent resources must use when supplying a value (e.g. currency expects {value, unit}, user expects a Greenhouse user id, single_select/multi_select expect option ids or names). Set at creation only — value_type cannot be changed once the field exists.

field_type

string

required

Resource the field attaches to (candidate, job, offer, opening, application, user_attribute, etc.). Determines which sibling create endpoint shape applies — see the field-type-specific variants of this request.

private

boolean

If true, only users granted the matching View Private permission can see this field's values.

generate_email_token

boolean

If true, mints an email merge token that can be used to inject this field's value into candidate emails.

custom_field_options

array of objects

length ≤ 1000

Initial option list for single_select / multi_select fields. Ignored for other value types. After creation, manage options via /v3/custom_field_options.

custom_field_options

description

string

Helper text shown beneath the field label in the UI. Plain text only.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful