Skip to main content
PATCH
Set the people on a form fill

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

Body

application/json
people
object[]
required
Maximum array length: 20

Response

Success.

object
enum<string>
required
Available options:
form_fill
id
string
required
number
number
required
client_id
string
required
name
string
required
form_id
string | null
required

The library form it was filled from, or null for a one-off upload.

layout_id
string
required
group_id
string | null
required

Fills made together for each member of a couple share it.

status
enum<string>
required

draft (values to check or missing), waiting_on_client (asked through a checklist item) or ready (nothing left to check or give; it can be downloaded).

Available options:
draft,
waiting_on_client,
ready
detection
enum<string>
required

Finding the form’s fields: waiting or running while we read a new form, ready, or failed.

Available options:
waiting,
running,
ready,
failed
mapped
boolean
required

Whether the form’s fields are matched to sources yet. A new form takes up to two minutes.

people
object[]
required

Which client person is each person on the form.

checklist_item_id
string | null
required

The checklist item that asked the client for the missing fields.

counts
object
required

How many fields are in each state.

created_at
string
required

An ISO 8601 time in UTC.

updated_at
string
required

An ISO 8601 time in UTC.

downloaded_at
string | null
required

An ISO 8601 time in UTC.

page_count
number
required
kind
enum<string>
required

acroform (a fillable PDF), flat or scanned.

Available options:
acroform,
flat,
scanned
roles
object[]
required

The people the form is about. Set who each is with update_form_fill.

mapping_version
number | null
required
fields
object[]
required