Skip to main content
PATCH
Update a form

Authorizations

Authorization
string
header
required

A Sorraia API key created in the dashboard (Settings → API keys). Pass it as Authorization: Bearer sor_live_....

Path Parameters

id
integer
required

The resource id.

Body

application/json

Partial update. Only these fields are mutable. Sending userId, orgId, domainId, createdAt, or id returns a forbidden_field error.

name
string
fields
object[]
webhookUrl
string<uri> | null
archived
boolean

Response

The updated form.

id
integer
required
name
string
required
type
enum<string>
required
Available options:
standard,
multi-step
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
domain
object | null

Bound domain, or null for legacy unbound forms.

submissionCount
integer

Present on list responses; omitted on the single-resource view.

fields
object[]

The form's field schema. Present on the single-resource (detail) view only.