Skip to main content
Version: 1.28 (Current)

Add Checkbox List

Audience: Low-code Engineers

Skill Prerequisites: Forms, Tokens

Adds a list of checkboxes, where users can tick several options, to a Dynamic Field Container when the form loads. It works like a Checkbox List field placed in the form builder.

See Dynamic Fields for how dynamic fields work and how to set up the container.

Typical Use Cases​

  • Let users choose all the options that apply, for example services they're interested in
  • Add a checkbox list whose options depend on the user or the record being edited

Don't use it to​

Action NameDescription
Add Dropdown with CheckboxesShows the checkboxes in a dropdown.
Add Radio BoxesAllows only one selection.

Input Parameter Reference​

This action has the common parameters, except Secure Input and Readonly, and the list parameters, including Link To. It also has:

ParameterDescriptionSupports TokensDefaultRequired
Display HorizontallyEnter true to show the checkboxes side by side instead of one per line.Yesempty stringNo
Checkbox Group LegendA heading for the group. When set, the checkboxes are wrapped in a fieldset with this legend.Yesempty stringNo
Fieldset CSS ClassesCSS classes for the fieldset, separated by spaces. Used only when Checkbox Group Legend is set.Noempty stringNo
Fieldset CSS StylesInline styles for the fieldset. Used only when Checkbox Group Legend is set.Noempty stringNo
Legend CSS ClassesCSS classes for the legend, separated by spaces. Used only when Checkbox Group Legend is set.Noempty stringNo
Legend CSS StylesInline styles for the legend. Used only when Checkbox Group Legend is set.Noempty stringNo

Output Parameters Reference​

ParameterDescription
Field ID Token NameOptional. Token that receives the cleaned field ID. If empty, the ID is saved in [<FieldId>:Name].

When the form is submitted, [<FieldId>] holds the selected values separated by commas. See Values of list fields.

Examples​

tip

To understand how to use the below examples, please see Running Examples.

1. Add a services checkbox list​

Add this action to the form's On PreInit or On Init actions. It adds a horizontal list of services to the ExtraFields container.

{
"Title": "Add Checkbox List",
"ActionType": "AddMultipleChoiceWithCheckboxes",
"Description": "Add the services list",
"Condition": null,
"Parameters": {
"ContainerId": "ExtraFields",
"FieldId": "Services",
"FieldName": "Which services are you interested in?",
"InitialValue": "",
"Horizontal": "true",
"Legend": "",
"DataSource": {
"Expression": "",
"Value": "Items",
"IsExpression": false,
"Items": "Consulting|consulting\nTraining|training\nSupport|support"
},
"TokenizeParameters": true,
"LinkToFields": "",
"IsRequired": "false",
"FieldIdTokenName": ""
}
}

Revised 09/25/2026