CreateFormRequest

Request schema for creating a form.

fields object[]

The fields in the form.

Array [

descriptionstringnullable

Optional help text displayed below the field.

idstring

Unique identifier for the field. Optional on create; include to reference an existing field on update.

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

• FieldOptionsInput
• string

allow_otherbooleanrequired

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

choices object[]required

List of available choices.

Array [

idstring

Unique identifier for the choice. Optional on create; include to reference an existing choice on update.

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]

]

internal_namestringrequired

The name of the form.

CreateFormRequest

{
  "fields": [
    {
      "key": "full_name",
      "label": "Full Name",
      "position": 0,
      "required": true,
      "type": "short_text"
    }
  ],
  "internal_name": "Intake Form"
}