UpdateFormRequest
Request schema for updating a form.
fields object[]
The fields in the form.
Optional help text displayed below the field.
Unique identifier for the field. Optional on create; include to reference an existing field on update.
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_]*$
Display label for the field.
For boolean fields, whether the value must be true (e.g., consent checkboxes).
options objectnullable
Options configuration for choice-type fields.
- FieldOptionsInput
- string
Whether to allow a free-text 'other' option.
choices object[]required
List of available choices.
Unique identifier for the choice. Optional on create; include to reference an existing choice on update.
Display label for the choice.
Display position of the field within the form.
Whether the field is required.
Whether the field contains sensitive data.
The field type.
Possible values: [short_text, long_text, email, phone, boolean, radio, select, checkbox]
The name of the form.
{
"internal_name": "Updated Intake Form"
}