Onboarding Wizard | SalesOS Docs

Get overall onboarding progress

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/onboarding/progress" \
  -H "Authorization: Bearer <token>"

Get all onboarding steps

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/onboarding/steps" \
  -H "Authorization: Bearer <token>"

Mark an onboarding step as completed

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Step ID

curl -X POST "https://api.salesos.org/v1/onboarding/steps/<string>/complete" \
  -H "Authorization: Bearer <token>"

Skip an onboarding step

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Step ID

curl -X POST "https://api.salesos.org/v1/onboarding/steps/<string>/skip" \
  -H "Authorization: Bearer <token>"

Get contextual onboarding recommendations

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/onboarding/recommendations" \
  -H "Authorization: Bearer <token>"

Reset onboarding progress

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/onboarding/reset" \
  -H "Authorization: Bearer <token>"

Get onboarding wizard configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/onboarding/config" \
  -H "Authorization: Bearer <token>"

Update onboarding wizard configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X PATCH "https://api.salesos.org/v1/onboarding/config" \
  -H "Authorization: Bearer <token>"

Get onboarding statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/onboarding/stats" \
  -H "Authorization: Bearer <token>"