ONBOARDING STATE MANAGEMENT

27. GET /onboarding/progress

Get the current onboarding progress and state for resuming. Requires authentication.

Request

GET /onboarding/progress
Authorization: Bearer <token>

Response 200 OK

{
  "status": "success",
  "data": {
    "creator_id": "creator_001",
    "current_step": 4,
    "total_steps": 6,
    "percent_complete": 60,
    "is_complete": false,
    "steps": [
      {
        "step": 1,
        "label": "Create Account",
        "status": "complete",
        "completed_at": "2024-11-01T09:50:00Z"
      },
      {
        "step": 2,
        "label": "What do you create?",
        "status": "complete",
        "completed_at": "2024-11-01T09:52:00Z"
      },
      {
        "step": 3,
        "label": "Connect your audience",
        "status": "complete",
        "completed_at": "2024-11-01T09:54:00Z"
      },
      {
        "step": 4,
        "label": "Import your content",
        "status": "in_progress",
        "completed_at": null
      },
      {
        "step": 5,
        "label": "Set up monetization",
        "status": "pending",
        "completed_at": null
      },
      {
        "step": 6,
        "label": "Launch",
        "status": "pending",
        "completed_at": null
      }
    ],
    "resume_url": "/onboarding/step/4"
  }
}

28. PATCH /onboarding/progress

Update the current onboarding step (used for back navigation). Requires authentication.

Request

PATCH /onboarding/progress
Authorization: Bearer <token>
Content-Type: application/json

Request Body

{
  "current_step": 3
}

Request Body Parameters

Field	Type	Required	Description
current_step	int	Yes	Step to navigate to (1–6)

Response 200 OK

{
  "status": "success",
  "data": {
    "current_step": 3,
    "total_steps": 6,
    "percent_complete": 40
  }
}