Fields
Objects have default fields, with some fields only being available when a workflow is enabled for an object. These fields cannot be deleted, but the % chance to close field and last modified field can both be hidden from view in the UI.
Custom Fields
Additional fields defined on an object are called custom fields. These fields can be hidden like some of the default fields, and can be deleted at any time.
When adding a custom field, an assortment of field types are supported, with unique validation logic and rules:
| Field Type | Limits or Restrictions | Table Display Behavior |
|---|---|---|
| Checkbox | If value is null, considered unchecked | Displays as text "yes" or "no" |
| Checkboxes | ||
| Date | ||
| DateTime | ||
| Number (Decimal) | ||
| Number (Integer) | 4 bytes | |
| Dropdown | ||
| Dynamic Tags | ||
| Must be a valid email format | Displays as a clickable mailto link | |
| Files | 10Mb limit | |
| LongText | ||
| Text | 255 character limit | |
| Money/Currency/Price | ||
| Phone Number | Must be a valid phone number | |
| Radio Buttons | ||
| Rating | Configurable to allow a range of 5 or 10 values | |
| Relationship | Multiple types of relationships: - 1:1 - 1:Many - Many:1 - Many:Many Will also create an inverse relationship field. | Summary is displayed after 20 values on the timeline. API response for this field will be summarized if there are more than 100 field values* |
| Status | Shows colored dots associated with each status | |
| Team Selector | Only displays active employees as options | |
| Yes/No/Maybe | "Maybe" is optional, can be set to only "Yes"/"No" as options |
* When a relationship field response is summaried, the API returns a
value_summary. In this case, an additional call can be made to/api/custom_objects/{object_id}/fields/{field_id}/optionsto fetch all the non-summarized values.
Blank Field Values
When a field value is left blank, the field will be omitted from the API response when fetching a record. This means that the response cannot be used to determine all fields that are available for a given record.
Field Schema
In addition to the field type, the field schema also stores information about how the field behaves through a few flags:
is_required– The field must be specified when creating a recordallows_nulls– The field will acceptNoneornullas a valueallows_empty– The field value can be empty. The rules differ for different field types:- text/string types –
""is empty - array/list types –
[]is empty - object type –
{}is empty - For other field types,
allows_emptyis not applicable.
- text/string types –
If a field both is not required and allows empty, it is considered clearable.
Up Next
Further documentation on default fields for different objects.