Types

FormFieldUpdate

The body that changes a form field. Send only what you change; everything else is kept.

type
string
The new field type. It must be compatible with the current type; see the compatible-types read.
label
string | null
The question shown to the person filling in the form.
name
string | null
The field's short name.
description
string | null
Help text shown under the question.
reference
string | null
A key that stays stable across edits, unique within the form.
validator
string | null
Validation rules separated by a pipe, such as required|string.
placeholder
string | null
Placeholder text.
pre_population_key
string | null
The profile value that pre-fills this field.
backfill
boolean | null
Whether the answer is written back to the profile.
order
integer | null
The field's position within the form.
page_id
string | null (uuid)
A page of this form to place the field on. Null removes it from its page.
option_preset_id
string | null (uuid)
A live option preset a dropdown field takes its options from. Null unlinks it.
options
array | object | null
The options of a dropdown or similar field. A list for most types; an object for a DOCUSIGN field.
condition_logic
string | null
Whether all conditions (AND) or any one (OR) must hold.One of: AND, OR
conditions
array | null
Display conditions. Send an empty list to remove them; leave the key out to keep them.

Used by (1)