API Reference

customField.create

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

Create a new custom field

Requires the hiringProcessMetadataWrite permission.

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.

Allowed:
string
required

The name of the field

string

A description for the field

selectableValues
array of objects

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

selectableValues
boolean

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

boolean
Defaults to false

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.

Response

Updated 5 months ago

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