Skip to main content

Form builder

The form builder lets you design the questions a customer fills in when submitting a product request. Forms are built using a visual drag-and-drop editor and support a versioning system so you can iterate on a form without disrupting the live version.

A form you create here can then be attached to an offer configuration (Offer configurations) to make it available in the storefront.

Create a new form​

  1. Open Site in the main navigation and select Form Builder.
  2. Click Create in the top-right corner.
  3. Fill in the General fields (see table below).
  4. Click Save.

General fields​

FieldWhat it does
NameA clear and descriptive name for this form. Required.
IdentifierA unique, URL-safe code using only letters, digits, hyphens, underscores, and dots. Used to reference the form externally.
StatusActive makes the form available for selection in offer configurations. Inactive hides it from that selector.
DescriptionFree-text notes for your team. Not shown to customers.

Create and edit a version​

A form has no content until you add at least one version. Each version is a separate snapshot of the form layout. Only one version can be published at a time.

Create the first version​

  1. Open the form you just created and locate the Editor section.
  2. Click Create Initial Version.
  3. Confirm the dialogue. An unpublished version appears in the table.

Add a new version​

  1. In the Editor section, click Create New Version.
  2. Confirm the dialogue. The new version is created as a copy of the most recent version and appears with status Unpublished.

Form versions

Open the visual editor​

  1. In the version table, click Edit on any unpublished version.
  2. The visual editor opens in a new view. Use the left panel to add fields to the canvas by clicking them or dragging them onto the layout.
  3. Click a field on the canvas to select it and adjust its settings in the right sidebar.
  4. Click Save in the header to save your changes without leaving the editor, or Save & Close to save and return to the form.

Form visual editor

note

Published versions are read-only. Click Duplicate on a published version to create a new editable copy based on it.

Preview a version​

Click Preview on any version that contains content to open a preview in a new browser tab. Preview is available for both published and unpublished versions that have at least one field.

Field types​

The left panel in the editor lists all available field types. Click a field type or drag it onto the canvas to add it. The following field types are available.

Field typeWhat it collects
Text InputA single line of free text, such as a name or reference number.
Multiline Text AreaMultiple lines of free text, such as comments or a description.
Number InputA numeric value, with optional min, max, step, and decimal settings.
Email InputAn email address, with optional domain allow-list or block-list validation.
Phone InputA phone number in international or national format, with optional country filtering.
Toggle SwitchA true/false choice shown as an on/off switch, with configurable labels for each state.
Single ChoiceA single selection from a list of options, displayed as radio buttons.
MultichoiceOne or more selections from a list of options, displayed as checkboxes.
DropdownA single selection from a list of options, shown as a standard or searchable drop-down.
Date/Time PickerA date, a time, or a combined date-and-time value, with optional min/max bounds.
Image UploadOne or more image files, with configurable file count, size, and dimension limits.

Field options​

When you click a field on the canvas, the right sidebar shows its options, divided into shared settings (present on every field) and settings specific to that field type.

Settings on every field​

SettingWhat it does
Field KeyA machine-readable identifier for this field (lowercase letters, digits, and underscores). Required. Used as the key in the submitted data.
LabelThe visible question or field name shown to the customer. Required.
PlaceholderGrey hint text shown inside the input before the customer types (not available on toggle, radio, or checkbox fields).
Help TextA short description shown below the field to guide the customer.
SizeVisual size of the field.
WidthHow wide the field appears in the layout (not available on toggle, radio, and multichoice fields).
VariantDisplay style for the field (not available on toggle, radio, multichoice, and dropdown fields).
Default ValueA pre-filled value the customer can change or keep (not available on date/time fields, which have their own default value setting).
Read-onlyWhen checked, the field is displayed but cannot be edited by the customer.
Hidden by defaultWhen checked, the field is hidden from customers on load.
RequiredWhen checked, the customer must fill in the field before submitting. Disabled automatically when the field is read-only or hidden.

Text Input — additional settings​

SettingWhat it does
Min LengthMinimum number of characters required.
Max LengthMaximum number of characters allowed.
Pattern (RegEx)A regular expression the value must match on submission.
Trim whitespace before validationWhen checked, leading and trailing spaces are stripped before the pattern and length checks run.

Multiline Text Area — additional settings​

SettingWhat it does
Min LengthMinimum number of characters required.
Max LengthMaximum number of characters allowed.
Max LinesMaximum number of visible lines in the text area. Leave empty for automatic height.

Number Input — additional settings​

SettingWhat it does
Min ValueLowest value the customer can enter.
Max ValueHighest value the customer can enter.
StepIncrement used by the stepper buttons.
Allow DecimalsWhen checked, decimal values are accepted.
Decimal PlacesNumber of decimal places allowed (visible only when Allow Decimals is on).

Email Input — additional settings​

SettingWhat it does
Max LengthMaximum number of characters allowed.
Allowed DomainsComma-separated list of permitted email domains (for example company.com). Leave empty to allow any domain. When set, all other domains are blocked.
Blocked DomainsComma-separated list of prohibited email domains. Cannot be combined with an allowed-domains list.

Phone Input — additional settings​

SettingWhat it does
Display VariantInternational — shows a country-code prefix selector (for example +1 555-123-4567).
National — local format only, requires a Default Country.
Default CountryPre-selects a country in the phone input. Required when using the National variant.
Allowed CountriesLimits valid country codes to the selected countries. Available for the International variant only.

Toggle Switch — additional settings​

SettingWhat it does
True LabelText shown next to the toggle when it is switched on (for example "Yes").
False LabelText shown next to the toggle when it is switched off (for example "No").

Single Choice — additional settings​

Manage the list of options customers can choose from. Each option has an ID and a label. You must add at least two options.

Multichoice — additional settings​

SettingWhat it does
Minimum SelectedMinimum number of options the customer must select.
Maximum SelectedMaximum number of options the customer can select.

Also manage the list of options, each with an ID and a label.

SettingWhat it does
TypeStandard Dropdown — a plain drop-down list.
Searchable Dropdown — adds a search box so customers can filter long lists.
Max Visible OptionsMaximum number of options visible in the dropdown without scrolling (Searchable Dropdown only). Leave empty for automatic height.

Also manage the list of options, each with an ID and a label.

Date/Time Picker — additional settings​

SettingWhat it does
Typedate — date only.
time — time only.
datetime — date and time together.
Default ValueA pre-filled date or time value shown when the form opens.
Minimum DateEarliest selectable date (date and datetime variants only).
Maximum DateLatest selectable date (date and datetime variants only).

Image Upload — additional settings​

SettingWhat it does
Max FilesMaximum number of images the customer can upload.
Max Size (MB)Maximum file size per image in megabytes. Maximum allowed is 5 MB.
Min Width (px)Minimum width in pixels for uploaded images.
Min Height (px)Minimum height in pixels for uploaded images.
Max Width (px)Maximum width in pixels for uploaded images.
Max Height (px)Maximum height in pixels for uploaded images.
Aspect RatioRequired aspect ratio for uploads, in width:height format (for example 16:9).

Save and publish​

Saving in the editor stores your layout changes to the unpublished version. You can save as many times as you like while the version is unpublished, saves are incremental and do not affect the live form.

Publishing a version makes it the active form that customers see. To publish:

  1. Return to the form's edit page (use Save & Close or the back button).
  2. In the Editor section, locate the version you want to publish.
  3. Click Publish and confirm the dialogue.
warning

Publishing a version is permanent. A published version becomes read-only and cannot be edited. To make further changes, duplicate it into a new version.

Once a version is published, the form's Status must be set to Active and the form must be assigned to an offer configuration (Offer configurations) before customers can see it.