Skip to main content
POST
Complete workspace onboarding

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. REST requires a Sanctum API key. Separately, interactive MCP clients can use registered OAuth applications with PKCE and audience-bound workspace grants; those tokens are not REST credentials.

Headers

Idempotency-Key
string

Optional 8–120 character key for replayable mutations. Send the exact same method, URI, and body on retries; receipts expire after 24 hours.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required

Body

application/json

Read onboarding first and send its current revision. Optional style settings follow the Button editor, including header and footer tabs. Stale revisions return 409. Completion may create draft resources; inspect returned state.

revision
integer
required
Required range: x >= 0
step
enum<integer>
required
Available options:
1,
2,
3,
4,
5,
7
business
object
required
interests
object
required

Keys from the returned tool catalog; each value is interested, later, or no.

widgets
string[]
required

Active widget slugs from the catalog. Required unless derived from widget_drafts; selection steps require at least one.

Maximum array length: 50
Maximum string length: 100
style
object
required
template
string | null

A recipe key from the current onboarding catalog.

widget_drafts
object[]
Maximum array length: 50
tool_order
string[]
Maximum array length: 100

Response

Successful data envelope.

data
any
required
meta
object
required