Types

FormFieldCreate

The body that adds a field to a form.

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)
A page of this form to place the field on.
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.
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. Every controlling field must be a field of this form.

Used by (1)