Custom Fields

Audience: Admins, Developers, Solution Architects

Purpose: Explains how default and custom fields are defined in Kizen, including supported field types, schema behavior, validation rules, and how field values are returned by the API.

Overview

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
Email	Must be a valid email format	Displays as a clickable mailto link
Files	50Mb 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

Note: When a relationship field response is summarized, the API returns a value_summary. In this case, an additional call can be made to /api/custom_objects/{object_id}/fields/{field_id}/options to 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 record

• allows_nulls – The field will accept None or null as a value

• allows_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_empty is not applicable.

If a field both is not required and allows empty, it is considered clearable.

---

What's Next

In the next section, Date & DateTime, you’ll learn how Kizen handles date and datetime fields, how business time zones affect stored values, and how to format date and datetime values correctly when using the API.

Related Topics

• Objects

• Records

• Date & DateTime

• Numbers

• Percentage Chance to Close

• Phone Number

• Rating