Add Checkbox List
Audience:
Low-code EngineersSkill 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
- Offer a single yes/no choice. Use Add CheckBox (True/False) instead.
- Show a long list. Use Add Dropdown with Checkboxes, which takes less space.
Related Actions
| Action Name | Description |
|---|---|
| Add Dropdown with Checkboxes | Shows the checkboxes in a dropdown. |
| Add Radio Boxes | Allows 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:
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Display Horizontally | Enter true to show the checkboxes side by side instead of one per line. | Yes | empty string | No |
| Checkbox Group Legend | A heading for the group. When set, the checkboxes are wrapped in a fieldset with this legend. | Yes | empty string | No |
| Fieldset CSS Classes | CSS classes for the fieldset, separated by spaces. Used only when Checkbox Group Legend is set. | No | empty string | No |
| Fieldset CSS Styles | Inline styles for the fieldset. Used only when Checkbox Group Legend is set. | No | empty string | No |
| Legend CSS Classes | CSS classes for the legend, separated by spaces. Used only when Checkbox Group Legend is set. | No | empty string | No |
| Legend CSS Styles | Inline styles for the legend. Used only when Checkbox Group Legend is set. | No | empty string | No |
Output Parameters Reference
| Parameter | Description |
|---|---|
| Field ID Token Name | Optional. 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
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