Skip to main content

Switch

Switch fields store one true-or-false value. Runtime users turn the switch on or off.

Use a switch field when the value is a binary state, such as completed, enabled, confirmed, reviewed, or accepted.

Basic Settings​

SettingDescription
NameThe field label shown to users. It is required and should describe the binary state clearly
API NameThe stable technical name used by data APIs, scripts, formulas, imports, and integrations. It is required
RequiredRequires the field to have a value before the record can be saved
ReadonlyShows the value but prevents users from changing it
DisabledMakes the field unavailable for normal use
HiddenStores the value while hiding it from normal form pages

Switch Field Config​

SettingDescription
Checked LabelText shown for the enabled state
Unchecked LabelText shown for the disabled state
Must Be TrueRequires the switch to be enabled before the record can be saved
Must Be True MessageCustom message shown when the switch must be enabled but is not
Validate TriggerControls when validation runs: when the value changes, when the field loses focus, or when the record is submitted
Field ColorSets the display color used for the field
Help TextHelper copy shown near the field. Use it to explain what enabling the switch means

Common Examples​

ScenarioChecked LabelUnchecked Label
Task completionCompletedNot Completed
Review stateReviewedNot Reviewed
AgreementAcceptedNot Accepted
Feature stateEnabledDisabled

Configuration Tips​

TipDescription
Name the positive stateA name such as Completed or Confirmed makes the checked state obvious
Use must-be-true for confirmationsTurn it on when users must explicitly accept or confirm something
Keep labels shortShort labels are easier to read beside a switch