Checkbox

Type key: checkbox. Renders one checkbox with the question as its label, typically for a consent or confirmation. In the editor this is the Checkbox block.

A question: the question rules apply, and it can sit in a layout row column.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the checkbox tab.

Example

A minimal Checkbox node

{
  "public_id": "nCoc",
  "sort_order": 1,
  "type": "checkbox",
  "meta": {
    "question": "<span>I agree to the code of conduct</span>",
    "validation": {
      "required": true
    }
  }
}

Defaults and rules

• A required checkbox must be ticked before respondents can continue, which suits terms and consents.
• default_value is a boolean; true renders the box ticked.
• placeholder is accepted but not shown to respondents.