Skip to content

Update Form Registry

PATCH
/forms/{form_key}

Rename a form, reassign its owner, or archive it.

Authorizations

Parameters

Path Parameters

form_key
required

Form key.

string

Form key.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rename, reassign or archive a form.

object
archived
Any of:
boolean
display_name
Any of:
string
>= 1 characters <= 200 characters
owner_id
Any of:
string
<= 200 characters
source_id
required

Which INSTALLED SOURCE of this form. A form key can be present on more than one source, and every operation on this surface is scoped to one - omitting it would silently act on whichever the backend picked.

string
>= 1 characters <= 500 characters

Responses

200

Successful Response

object
data
required

An open envelope for a form operational view.

overview, fields, placements, activity, a route save result and a submission trace each return a different shape assembled from several upstreams. Pinning any of them would drop a field the moment one is added, and on a delivery-diagnostics surface a missing field reads as a missing delivery.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string