Manage your users' experience by storing their personal settings and tracking their progress through multi-step setup wizards. This guide covers the API endpoints available for handling global user preferences and organization-specific documentation wizard states.

User Preferences

User preferences allow you to store custom settings for an individual user, such as UI themes, notification toggles, or dashboard layouts. These preferences are tied directly to the authenticated user and persist across different sessions.

Available Endpoints

Example Workflow

Here is a common pattern for managing user settings in your application:

1. 1

   Retrieve existing preferences

   When a user logs in, call GET /preferences to load their saved settings and apply them to the UI.

2. 2

   Update a specific setting

   When the user changes a setting (like switching to dark mode), use PUT /preference to save the change.

   curl -X PUT https://api.yourdomain.com/preference 
     -H "Authorization: Bearer YOUR_TOKEN" 
     -H "Content-Type: application/json" 
     -d '{"key": "theme", "value": "dark"}'

3. 3

   Clear a setting

   If the user wants to revert to the system default, use DELETE /preference to remove their custom override.

Wizard Progress

When users create or configure new documentation, you can track their progress through multi-step wizards. This ensures they can safely pause and resume their onboarding without losing data.

Unlike global preferences, wizard progress is scoped to a specific organization and documentation project.

Available Endpoints

Wizard Lifecycle

The following diagram illustrates how a client application should interact with the wizard progress endpoints during a standard onboarding flow:

sequenceDiagram
    participant User
    participant Client
    participant API

    User->>Client: Open Setup Wizard
    Client->>API: GET /wizard-progress/{doc_id}
    API-->>Client: Return saved state (e.g., Step 2)
    User->>Client: Complete Step 2
    Client->>API: POST /wizard-progress/{doc_id}
    API-->>Client: Confirm saved
    User->>Client: Finish Wizard
    Client->>API: DELETE /wizard-progress/{doc_id}
    API-->>Client: State cleared

Frequently Asked Questions