Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Custom Field

customField.create

Create a new custom field.

Requires the hiringProcessMetadataWrite permission.

post/customField.create

Request body

fieldType'Boolean' | 'CompensationRange' | 'Currency' | 'Date' | 'LongText' | 'MultiValueSelect' | 'Number' | 'NumberRange' | 'String' | 'ValueSelect' | 'Url' | 'UUID' required

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

objectType'Application' | 'Candidate' | 'Job' | 'Employee' | 'Talent_Project' | 'Opening' | 'Offer' | 'Opening_Version' | 'Offer_Version' required

The type of object the field can be associated with.

titlestring required

The name of the field

descriptionstring nullable

A description for the field

isDateOnlyFieldboolean nullable

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

isExposableToCandidateboolean nullable

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.

isPrivateboolean nullable

Whether the custom field should be private.

Response

Responses from the customField.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "title": "Preferred Team",
    "description": "A description of the custom field",
    "objectType": "Application",
    "isArchived": false,
    "isPrivate": false,
    "fieldType": "String",
    "isRequired": false
  }
}