Skip to main content

CustomField

Custom fields provide agents with the ability to define extra data on a contact or company, along with the means of specifying how that information is entered and displayed.

type CustomField implements Node, Timestamped {
  allowedOperators: [SupportedOperatorType!]
  category: CustomFieldCategory!
  createdAt: DateTime!
  createdBy: Agent!
  deletable: Boolean!
  description: String
  handleType: CustomFieldHandleType
  hidden: Boolean!
  icon: CustomFieldIcon!
  id: ID!
  isArray: Boolean!
  key: String!
  name: String
  options(
  after: String
  before: String
  first: Int
  last: Int
): CustomFieldOptionConnection
  placeholder: String
  position: Int
  required: Boolean!
  type: CustomFieldType!
  updatedAt: DateTime!
  updatedBy: Agent!
}

Fields​

CustomField.allowedOperators ● [SupportedOperatorType!] list object common​

The conditional operators that this custom field supports

CustomField.category ● CustomFieldCategory! non-null object common​

The category the custom field belongs to.

CustomField.createdAt ● DateTime! non-null scalar common​

The date and time that the object was created.

CustomField.createdBy ● Agent! non-null object common​

The agent that created the custom field.

CustomField.deletable ● Boolean! non-null scalar common​

True if the custom field can be deleted; false otherwise.

CustomField.description ● String scalar common​

A description of the custom field.

CustomField.handleType ● CustomFieldHandleType enum common​

The unique identifier type linked to this field

CustomField.hidden ● Boolean! non-null scalar common​

True if the custom field needs to be hidden in the UI; false otherwise.

CustomField.icon ● CustomFieldIcon! non-null enum common​

The icon for the custom field.

CustomField.id ● ID! non-null scalar common​

CustomField.isArray ● Boolean! non-null scalar common​

True if the custom field allows arrays of values; false otherwise.

CustomField.key ● String! non-null scalar common​

An immutable identifier for the custom field.

CustomField.name ● String scalar common​

The name of the custom field.

CustomField.options ● CustomFieldOptionConnection object common​

The available options for the custom field if the type is DROPDOWN.

CustomField.options.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

CustomField.options.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

CustomField.options.first ● Int scalar common​

Returns the first n elements from the list.

CustomField.options.last ● Int scalar common​

Returns the last n elements from the list.

CustomField.placeholder ● String scalar common​

The text to show in the input field when it is empty.

CustomField.position ● Int scalar common​

The position of the custom field within the category. The first item starts at

  1. Leave blank to append the custom field to the end of the list.

CustomField.required ● Boolean! non-null scalar common​

True if the custom field needs to be filled in the UI; false otherwise.

CustomField.type ● CustomFieldType! non-null enum common​

The data type of the custom field.

CustomField.updatedAt ● DateTime! non-null scalar common​

The date and time that the object was last updated.

CustomField.updatedBy ● Agent! non-null object common​

The agent that last updated the custom field.

Interfaces​

Node interface common​

An object with an ID.

Timestamped interface common​

An object with timestamp fields for when it was created and last updated.

Member of​

CustomFieldConnection object ● CustomFieldCreatePayload object ● CustomFieldEdge object ● CustomFieldOption object ● customFieldRestorePayload object ● CustomFieldUpdatePayload object ● CustomFieldValue object

Implemented by​

ConditionSourceUnion union ● RuleConditionSourceUnion union