Types

FormFieldWrite

A field in a form body.

id
string (uuid)
An existing field of this form, to change it. Leave it out to add a field, or to match one by `reference`.
typerequired
string
The field type, such as TEXT, BIGTEXT, INTEGER, EMAIL, DATE, DROPDOWN, CHECKBOX, CURRENCY, OPTION_SELECT, FILE_UPLOAD or SIGNATURE.
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)
An existing page of this form to place the field on.
page_number
integer | null
The order of a page to place the field on, including a page created in the same body. Send it or `page_id`, not both.
option_preset_id
string | null (uuid)
A live option preset a dropdown field takes its options from.
options
array | object | null
The options of a dropdown or similar field. A list for most types; an object for a DOCUSIGN field.
required
boolean | null
Accepted and ignored, so a fetched form can be sent back. Put requiredness in `validator`.
condition_logic
string | null
Whether all conditions (AND) or any one (OR) must hold. AND unless set.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 (4)