Skip to content
Account and onboarding

Move onboarding to a step

Moves the signed-in person's onboarding forward to step.

PUT /onboarding/step

Scope setup · Access Changes data · Operation id onboarding.update_step

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication).

productmetrics onboarding update-step --step welcome --json

Response

API response (200):

{
  "data": {
    "success": true
  },
  "request_id": "req_01JDG7W3KK91330PX41JJPXK0W"
}

CLI output: productmetrics onboarding update-step --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

The steps, in order: welcome, give_google_ads_access, labelizer_explainer, get_invited_or_create_account, dashboard_explainer, workspace_setup, complete. A step can only move forward (skipping ahead is allowed); writing the current step changes nothing. Read onboarding.get_state first. To finish onboarding call onboarding.complete, not this.

Body

NameTypeRequiredDescription
stepenumYesMoves the signed-in person’s onboarding forward to step. One of welcome, give_google_ads_access, labelizer_explainer, get_invited_or_create_account, dashboard_explainer, workspace_setup, complete.

Errors

A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the setup scope; connect again and allow it.",
    "details": {
      "required_scope": "setup"
    }
  },
  "request_id": "req_01J34KC9K29VKECCSSNQ563P4H"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the setup scope (details.required_scope): sign in again and allow it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Account and onboarding operations