user

record the invite context an account's onboarding tailors itself from (require superadmin, cloud only)

Changed on
post/users/onboarding_profile

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/onboarding_profile
  • Auth
    • HTTP bearer
    • or API key in cookie token

Request body

emailstring required
profileobject required

free-form context from the invite, every key optional. The frontend reads touch_point (answers onboarding's source question), company and workspace_name (prefill the first workspace's name), hub_projects (slugs surfaced first on an empty workspace), tools (integrations, used to pick hub projects when none are named) and starter_prompts ([{label, prompt}], replacing the home page's example prompts); unknown keys are kept and ignored

Response

profile recorded

Changes