Field

Definition of an individual field that belongs to an object type.

Fields

FieldTypeMode Description
arrayBooleanread-only

Flag indicating whether this field is represented as a JSON array, as opposed to an individual value.

availabilityStringread-only

Comments regarding when this field will be present in an object representation.

descriptionStringread-only

Description of this field (for profile fields, this information is localized).

displayNameStringread-only

Display name of this field (for profile fields, this information is localized).

editableBooleanread-only

Flag indicating that this field can be included on a create request, or modified on an update request.

filterableBooleanread-only

Flag indicating that this field is filterable (has a defined set of options).

nameStringread-only

The name of this field, as it will appear in a JSON representation.

newsEnabledBooleanread-only
optionsString[]read-only

Valid options when the field is of type multilist or singlelist.

Since: 3.4
requiredBooleanread-only

Flag indicating that this field MUST be included on a create or update request.

sinceStringread-only

Comments about the first version of the API in which this object became available.

typeStringread-only

The data type for values in this field.

unpublishedBooleanread-only

Flag indicating that this field is present for internal use only, and should not be considered to be generally available or documented.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations