Skip to main content
PATCH
Update onboarding form

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Onboarding form ID

Body

application/json
name
string
Required string length: 1 - 255
description
string | null
Maximum string length: 2000
status
enum<string>
Available options:
draft,
active,
archived
allowMultipleEntries
boolean
upsertFields
object[]

Fields to update (with fieldId) or add (without fieldId)

Maximum array length: 100
removeFieldIds
string<uuid>[]
Maximum array length: 100

Response

Form updated

data
object
required