API Reference

customField.create

post
https://api.ashbyhq.com/customField.create

Create a new custom field.

Project custom fields do not support Currency, NumberRange, or CompensationRange.

Job and opening custom fields can be configured so their values are editable only through the API when this capability is enabled for the organization.

Requires the hiringProcessMetadataWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of field being created. This value is case-sensitive.

string
enum
required

The type of object the field can be associated with.

string
required

The name of the field

A description for the field

array | null

Required when the field type is ValueSelect or MultiValueSelect. An array of selectable values for the field.

Only applies to fields with a fieldType of Date. Whether or not the field includes content other than a date.

Determines whether the field can be exposed to a candidate in certain contexts. In order for a custom field to be available in an email template this value must be true.

Whether the custom field should be private.

Whether the custom field's value can only be edited through the API. Supported for Job and Opening custom fields when enabled for the organization.

Response

Updated 4 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago