Add CheckBox (True/False)

Audience: Low-code Engineers

Skill Prerequisites: Forms, Tokens

Adds a single checkbox to a Dynamic Field Container when the form loads. It works like a CheckBox (True/False) field placed in the form builder.

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

Typical Use Cases

• Add a consent or confirmation checkbox that depends on what's being submitted
• Add a yes/no option for each item in a list, for example "Include" for each product

Don't use it to

• Let users pick several options from one list. Use Add Checkbox List instead.

Related Actions

Action Name	Description
Add Checkbox List	Adds a list of checkboxes.

Input Parameter Reference

This action has the common parameters, except Secure Input, Readonly, Is Required, Validation Condition, the custom validators and Tokenize Validators?.

Use Initial Value to check the box when the form loads: true checks it and false or empty leaves it unchecked.

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>] is True if the box is checked and False if it isn't.

Examples

tip

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

1. Add a newsletter opt-in

Add this action to the form's On PreInit or On Init actions. It adds an unchecked Send me the newsletter checkbox to the ExtraFields container.

{
    "Title": "Add CheckBox (True/False)",
    "ActionType": "AddDynamicCheckBox",
    "Description": "Add the newsletter opt-in",
    "Condition": null,
    "Parameters": {
        "ContainerId": "ExtraFields",
        "FieldId": "Newsletter",
        "FieldName": "Send me the newsletter",
        "FieldDescription": "",
        "InitialValue": "false",
        "FieldIdTokenName": ""
    }
}

Revised 09/25/2026