Referral Form Configuration Step Section Field

Output representation of a single field rendered within a step section of a referral form configuration, including display metadata, default value, and runtime behavior.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
apiNameStringAPI name of the field.Big, 67.067.0
defaultValueStringDefault value pre-populated for the field.Big, 67.067.0
descriptionStringDescriptive text for the field shown in the form builder to help admins understand the field’s purpose. The maximum supported length is 255 characters.Big, 67.067.0
displayAsStringDisplay override for picklist, boolean, or text fields.Big, 67.067.0
helpTextStringAdministrator-configured help text shown below the field.Big, 67.067.0
hiddenBooleanIndicates whether the field is hidden from the runtime intake form and preview (true) or shown (false). Hidden fields are still submitted using their configured default value, which lets administrators satisfy required-field constraints without user input.Big, 67.067.0
idStringID of the field record that’s associated with a step section.Big, 67.067.0
isRequiredBooleanIndicates whether users must specify a value for this field at runtime (true) or not (false).Big, 67.067.0
labelStringDisplay name of the field.Big, 67.067.0
placeholderStringPlaceholder text shown inside the field input.Big, 67.067.0
readOnlyBooleanIndicates whether the field is shown but locked at runtime so users can’t change its pre-filled value (true) or is editable (false). Read-only fields are still rendered with their configured default value.Big, 67.067.0
sequenceIntegerSequence in which the field appears within its step section, starting from 1. Lower values appear first on the screen.Big, 67.067.0
targetObjectApiNameStringAPI name of the object referenced by the lookup field.Big, 67.067.0
typeStringData type of the field, such as Text and Picklist.Big, 67.067.0