CustomField properties

id

integer

ID of the custom field.

external_id

string | null

ID of the custom field in a foreign system (ex: Zendesk).

object_type

None

Type of entity on which to use this custom field.

label

string

The name of the custom field.

description

string | null

The description of the custom field.

priority

integer

Order in which custom fields are displayed.

required

boolean | null

Whether this custom field is required.

managed_type

ManagedTicketFieldType | ManagedCustomerFieldType | null

The type of the managed field.

definition

TextDataTypeDefinition | NumberDataTypeDefinition | BooleanDataTypeDefinition

The settings for this custom field, dependent on the data type.

created_datetime

ISO 8601 datetime

When the custom field was created.

updated_datetime

ISO 8601 datetime

When the custom field was last updated.

deactivated_datetime

string | null

When the custom field was deactivated.

CustomField example object

{
  "id": 123,
  "external_id": "custom-field-84203241",
  "object_type": "Ticket",
  "label": "Test field",
  "description": "An amazing field description.",
  "priority": 1,
  "required": true,
  "managed_type": "contact_reason",
  "definition": {
    "input_settings": {
      "placeholder": "Enter this here..."
    }
  },
  "created_datetime": "2019-01-02T03:04:05.123456",
  "updated_datetime": "2020-01-02T03:04:05.123456",
  "deactivated_datetime": "2021-01-02T03:04:05.123456"
}