Field Definition Model

Represents a definition of a custom field. Depending on the custom field definition this definition can be for parties, opportunities or projects.

Name Type Description
id Long Read only

The id of this custom field definition. Note that field definitions assignable to different entities (parties, opportunities or projects) can have the same id.

name String Required

The name of this custom field.

description String

A longer description of the purpose of this custom field.

type String Required

The type of this custom field.

Accepted values are: text, date, list, boolean, number, link

tag Nested Tag

Represents which datatag (if any) this custom field is part of.

captureRule String

Represents whether this custom field can be added to people, organisations or both. Is present only on party custom fields.

Accepted values are: person, organisation

options Array of String

Represents the possible values of this custom field. Is present and required only if type is list.

important Boolean

Indicates if this custom field is Important. Important fields are highlighted when adding or editing records, and a warning indicator is displayed on records where the field doesn't have a value.