Skip to main content

CustomFieldType

Defines the type of data collected in a custom field.

enum CustomFieldType {
  AMOUNT
  CHECKBOX
  DATE
  DOCUMENT
  HTML
  NUMBER
  TAG
  TEXT
}

Values​

CustomFieldType.AMOUNT​

A custom field type for storing a monetary amount. The value can be positive or negative and can include up to 2 decimal places.

CustomFieldType.CHECKBOX​

A custom field type for storing a Boolean value (true or false).

CustomFieldType.DATE​

A custom field type for storing a date. Dates only include year, month and day components.

Dates are serialised in the format yyyy-MM-dd.

CustomFieldType.DOCUMENT​

A custom field type for storing a document. The value is a URL representing the location that the document is stored in.

When the custom field's definition is flagged as containing personal data, the URL will be short-lived and should not be stored or relied upon beyond immediate use.

CustomFieldType.HTML​

A custom field type for storing HTML content. The value is an HTML fragment that can be displayed on a web page.

CustomFieldType.NUMBER​

A custom field type for storing a number. The value can be positive or negative and can include up to 2 decimal places.

CustomFieldType.TAG​

A custom field type for storing a tag. Tag values are pre-defined text strings defined for the custom field.

CustomFieldType.TEXT​

A custom field type for storing a single line of text.

Member Of​

ContactStoreCustomFieldDefinition object ● CustomField object ● CustomFieldDefinition interface ● EventCustomFieldDefinition object ● GloballyScopedCustomFieldDefinition object