account

Complete onboarding

Finishes workspace onboarding in a single call: renames the workspace to the given name, records the industry and complexity tier, marks onboarding as complete, and seeds a starter set of ready-to-play content tailored to the chosen industry. Combining these into one call ensures the completion flag and the seeded content are never out of sync.

Notes.

  • Every call adds the starter content again; it is not idempotent.
  • tier is stored as sent without a check.
post/v1/account/onboarding

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/account/onboarding
  • Auth: HTTP bearer

Request body

workspaceNamestring

Renames the workspace and sets the brand company name (cut at 120).

industrystring nullable

Industry id (cafe, qsr, gym, …); picks the starter designs.

tier'simple' | 'team' | 'enterprise'
setupStepstring

Walkthrough position to save with the answers.

welcomeDeclinedboolean

The owner declined the setup questions: adds the generic starter set and records prefs.welcomeDeclinedAt. Any other call clears it.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.