Skip to main content
PATCH
Change or accept a form value

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Scopes

forms:write

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
form_fill
string
required

The form fill id, from list_form_fills.

Required string length: 1 - 60
value
string
required

The value id, from list_form_fill_values.

Required string length: 1 - 60

Body

application/json
new_value
string · null · null

The value to write, or null to fill it from its source again.

Maximum string length: 2000
accept
enum<boolean> | null

Accept the value that waits for a check, as it stands.

Available options:
true

Response

Success.

object
enum<string>
required
Available options:
form_fill_value
id
string
required
field_id
string
required
label
string
required
type
enum<string>
required
Available options:
text,
checkbox,
radio,
dropdown,
option_list,
signature,
table,
unknown
section
string | null
required
page
number
required
role
string | null
required
state
enum<string>
required

filled, to_check (a member checks it before the form downloads), missing, or left_for_client (signatures and numbers Advisor never keeps).

Available options:
filled,
to_check,
missing,
left_for_client
value
string | null
required

What is written to the form, formatted for the field.

display
string
required

The value as a person reads it.

proposed_value
string | null
required

The value found, while it waits for a check.

source
object | null
required

Where the value came from.

to_check_reason
enum<string> | null
required
Available options:
runs_disagreed,
fact_old,
sources_disagree,
low_confidence,
overflows,
not_an_option,
fund_type_unknown,
provider_unclear,
owner_unclear,
depends_on_choice,
answer_differs,
business_unclear,
firm_unclear,
several_funds,
state_box_unseen,
printed_differs
edited_by_member_id
string | null
required
reviewed_at
string | null
required

An ISO 8601 time in UTC.

form_fill
object
required