Skip to main content

FormField

A field within a form.

descriptionstringnullable

Optional help text displayed below the field.

idstring

Unique identifier for the field.

keystringrequired

Machine-readable key for the field. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.

Possible values: Value must match regular expression ^[a-z][a-z0-9_]*$

labelstringrequired

Display label for the field.

must_be_trueboolean

For boolean fields, whether the value must be true (e.g., consent checkboxes).

options objectnullable

Options configuration for choice-type fields.

oneOf
allow_otherbooleanrequired

Whether to allow a free-text 'other' option.

choices object[]required

List of available choices.

  • Array [
    • idstringrequired

    Unique identifier for the choice.

    labelstringrequired

    Display label for the choice.

  • ]
    • positionintegerrequired

    Display position of the field within the form.

    requiredboolean

    Whether the field is required.

    sensitiveboolean

    Whether the field contains sensitive data.

    typestringrequired

    The field type.

    Possible values: [short_text, long_text, email, phone, boolean, radio, select, checkbox]

    FormField
    {
      "description": null,
      "id": "ff_abc123",
      "key": "full_name",
      "label": "Full Name",
      "must_be_true": false,
      "options": null,
      "position": 0,
      "required": true,
      "sensitive": false,
      "type": "short_text"
    }