Field Type Reference

The field type and workflow type may not refer to the same type.

DevNote add some additional context about this.

Checkbox (Y/N)

A Checkbox field stores a true/false (truthy/faulty) value (a boolean).

A Checkbox field should be used when you wish to store a truthy/faulty value. For example, if the subscription was paid or whether the contact is subscribed to your newsletter.

A field of type Checkbox is represented as a label when it is being viewed. When the field is being edited, it is represented as a checkbox.

Table 1. Additional configurations:
True label	This option allows you to specify the display label of truthy values.
False label	This option allows you to specify the display label of faulty values.

Table 2. Value validation:
Format	The value format for a truthy value must be one of the following: `true` `t` `yes` `y` `1` Any non truthy value is considered to be a falsy value.

Date and time

The Date and time field type stores a temporal value (a timestamp).

The Date and time field type should be used when you wish to store some temporal information; a date, a time, or both. For example, the time that the lead was converted.

A field of the Date and time type is represented as a formatted string when viewed. When the field is being edited, it is represented as a date input, a time input, or a date-time input (depending on the configuration).

Table 3. Additional configurations:
Date only	Removes the time part of the timestamp and only keeps the date. When editing the field, only the date input is shown.
Time only	Removes the date part of the timestamp and only keeps the time. When editing the field, only the time input is shown.
Past values only	Changes the value validator to only allow past values. The displayed date-time picker disables future values.
Future values only	Changes the value validator to only allow future values. The displayed date-time picker also disables past values.
Output relative value	Displays the value relative to the current time. For example, `10min ago`, or `last month`.
Output format	Defines the format string that is used when displaying the timestamps. The field supports all of the moment.js formatting options.

Table 4. Value validation:
Format	The `Date and time` field supports a wide range of formats. Below is the list of supported date-time parsing formats. Date only: `2006-01-02` `02 Jan 06` `Monday, 02-Jan-06` `Mon, 02 Jan 2006` `2006/_1/_2` Time only: `15:04:05` `15:04` `15:04:05Z07:00` `15:04:05 MST` `15:04:05 -0700` `15:04 MST` `15:04Z07:00` `15:04 -0700` `3:04PM` `2006-01-02T15:04:05Z07:00` `Mon, 02 Jan 2006 15:04:05 -0700` `Mon, 02 Jan 2006 15:04:05 MST` `Monday, 02-Jan-06 15:04:05 MST` `02 Jan 06 15:04 -0700` `02 Jan 06 15:04 MST` `Mon Jan 02 15:04:05 -0700 2006` `Mon Jan 02 15:04:05 -0700 2006` `Mon Jan _2 15:04:05 2006` `2006/_1/_2 15:04:05` `2006/_1/_2 15:04` The usual time format is `ISO 8601` with the pattern of `YYYY-MM-DDTHH:MM:SSZ`.
Future	When the field is configured to only allow future values, the validator rejects any value which is before the timestamp of when the validation occurred.
Past	When the field is configured to only allow past values, the validator rejects any value which is after the timestamp of when the validation occurred.

Email

An Email field type stores an email address.

The Email field type should be used when you wish to store an email, for example, the primary email address of the client.

A field of type Email is represented as a label or a clickable link when it is being viewed (depends on the configuration). When the field is being edited, it is represented as an email input box.

Internally, the email is stored as a plain-text regardless of the configuration. Display formatting is performed in the front-end application.

Table 5. Additional configurations:
Don’t turn email into a link	Displays the email as a regular string and not as a clickable link.

Table 6. Value validation:
Format	The `Email` field accepts any email format defined by `RFC 5322`. An example of the most common format is `recipient@mail.tld`.

Select / dropdown

A select / dropdown field type stores a value from a pre-defined set of options.

The select / dropdown field type should be used when you wish to force suers to pick one of the pre-defined values. For example, the stage of a case or the stage of a lead.

A field of type select / dropdown is represented as a label when it is being viewed. When the field is being edited, it is represented as a dropdown input box.

Options

Defines a set of available options that the field can have. For example, new, in progress, closed.

An option is a value-label pair, where the label defines how the value is displayed to the user.

Internally, the select field is represented by the value and not the label. When you’re referencing the field via automation or an external integration, make sure to use the value and not the label.

Multiple value input type

Defines how the multi-value variant of the field is represented.

DevNote list and describe the options?

Table 8. Value validation:
Value	The `Select` field only permits the use of values defined in the field configuration.

Number

A Number field type stores a numeric value.

The Number field type should be used when you wish to store any numeric value. For example, the cost of a subscription or the cost of a lead.

A field of type Number is represented as a formatted label when it is being viewed. When the field is being edited, it is represented as a number input box.

Prefix

Adds the specified prefix to the numeric value. For example, the prefix of $ and the value of 1000 would result in the label of $1000.

Suffix

Adds the specified suffix to the numeric value. For example, the suffix of USD/h and the value of 1000 would result in the label of 1000USD/h.

Precision

Defines the precision at which the value is to be stored. For example, the precision of 3 would allow you to store numbers with up to three decimal places.

The precision is limited to 6.

Format

Defines the format string that is used when displaying the numbers. The field supports all of the numeral.js formatting options.

Table 10. Value validation:
Value	The `Number` field only permits values which can be represented as a 64bit float. Examples of the most common representations include `1024` and `1024.256`.

Record

A Record field type stores a reference to another record.

The stored value is the recordID to the referenced record. If you wish to access the values of the referenced record, you need to fetch it from the REST API.

The Record field type should be used when you wish to define a relation between two modules. For example, the parent transaction or the account owner.

You can only reference records in the same namespace.

A field of type Record is represented as a clickable link to the related record when it is being viewed. When the field is being edited, it is represented as a searchable dropdown box.

Table 11. Additional configurations:

Module

Defines - the records of which module a field is linked to.

Record label field

Defines what module field from the related module should be used when displaying it’s records records.

Pre-filter records

Defines the pre-filter that is used when searching for the related records. Refer to the QL reference for details.

Query fields on search

Defines what fields are used for querying when searching over related records.

Multiple value input type

Defines how the multi-value variant of the field is represented.

DevNote list and describe the options?

Table 12. Value validation:
Value	The `Record` field only permits record IDs (references to other records) which exist in the system.

String

A String field type stores a generic text value.

The String field type should be used when you wish to store text. For example, the name of a contact or the TOS that should be shown to the client.

A field of type String is represented as a text when it is being viewed. When the field is being edited, it is represented as a text input box or a rich text input box (depending on the configuration).

Table 13. Additional configurations:
Multi-line	Changes the simple input box to be a multi-line text area.
Use rich text editor	Changes the simple string input to be a multi-line rich text editor. The value is encoded as a standard HTML document, therefore the value can be used in applications where HTML is accepted.

URL

A URL field type stores a URL address.

The URL field type should be used when you wish to store a URL address. For example, the link to the client’s homepage.

A field of type URL is represented as a label or a clickable link when it is being viewed (depending on the configuration). When the field is being edited, it is represented as a URL input box.

Internally, a URL is stored as a plain-text regardless of the configuration. Display formatting is performed in the front-end application.

Table 14. Additional configurations:
Trim # from the URL	Removes the URL fragment (the text after the `#`).
Trim ? from the URL	Removes the URL query (the text after the `?`).
only allow SSL (HTTPS) URLs	Only allows secure (HTTPS) URL addresses.
Don’t turn URL into a link	The URL address is shown as a regular label instead of a clickable link.

Table 15. Value validation:
Format	The `URL` field only permits valid URL strings which define a scheme and a host. The pattern for a valid URL is `[scheme:][//[userinfo@]host][/]path[?query][#fragment]`.
Secure	When the field is configured to only allow secure URLs, the scheme must equal to `https`.

User

A User field type stores a reference to a system user.

The stored value is the userID to the referenced user. If you wish to access the values of the referenced user, you need to fetch it from the REST API.

The User field type should be used when you wish to define a relation between a record and a system user. For example, the owner of the record or the task assignee.

A field of type User is represented as label when it is being viewed. When the field is being edited, it is represented as a searchable dropdown box.

Table 16. Additional configurations:
Pre-filter users	Defines the pre-filter that is used when searching for the related user. Refer to the QL reference for details.
Preset with current user	When checked, the current user will populate the given field by default.
User roles	Filters the users based on their membership.
Multiple value input type	Defines how the multi-value variant of the field is represented.

Table 17. Value validation:
Value	The `User` field only permits user IDs (references to users) which exist in the system.

File upload

A File upload field type stores a reference to an uploaded attachment.

The stored value is the attachmentID to the referenced user. If you wish to access the values of the referenced file, you need to fetch it from the REST API.

The File upload field type should be used when you wish to attach a document to the record. For example, a client’s quote or a legal document.

A field of type File upload is represented as clickable link when it is being viewed. When the field is being edited, it is represented as a drag-and-drop file upload box.

Table 18. Additional configurations:

View mode

Defines how the files are presented when they are being viewed.

DevNote list & describe the available options.

Table 19. Value validation:
Value	The `File` field only permits file IDs (references to files) which exist in the system.

Location

A Location field type stores a location which can be selected and plotted on a map.

The Location field type should be used when you wish to store a location. For example, a client’s geo location.

A field of type Location is represented as a location on a map. When the field is being edited, it is represented as a selectable location on a map.

The Location field does not define kind specific configuration options.