Skip to main content
PATCH
Rename a form

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

form
string
required

The form id, from list_forms.

Required string length: 1 - 60

Body

application/json
name
string | null
Required string length: 1 - 120
issuer
string · null · null

Who publishes the form, such as a super fund or a lender.

Maximum string length: 120

Response

Success.

object
enum<string>
required
Available options:
form
id
string
required
number
number
required
name
string
required
issuer
string | null
required
layout_id
string
required
mapping_version
number | null
required
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
field_count
number
required
page_count
number
required
archived
boolean
required
archived_at
string | null
required

An ISO 8601 time in UTC.

replaces_form_id
string | null
required

The form this one is a newer version of.

created_at
string
required

An ISO 8601 time in UTC.

updated_at
string
required

An ISO 8601 time in UTC.

roles
object[]
required
mapping_status
enum<string> | null
required
Available options:
proposed,
confirmed
replaced_by_form_id
string | null
required
mapping
object[]
required

Every field with where it fills from.