> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lobbystack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Skip setup steps

> Skips steps, or brings them back, as the dashboard's setup guide does. A skipped step no longer counts as missing.



## OpenAPI

````yaml /api-reference/openapi.json patch /onboarding
openapi: 3.1.0
info:
  title: LobbyStack API
  version: v1
  description: >-
    Read calls, contacts, appointments and messages, book appointments, and
    subscribe to webhooks. Authenticate with an API key in the Authorization
    header. A platform key also names the business it acts on in the
    LobbyStack-Business header. Each key allows 120 requests per minute by
    default.
servers:
  - url: https://app.lobbystack.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Business
  - name: Receptionist
  - name: Billing
  - name: Phone numbers
  - name: Onboarding
  - name: Team
  - name: Website chat
  - name: Calendars
  - name: Notifications
  - name: Calls
  - name: Contacts
  - name: Appointments
  - name: Messages
  - name: Knowledge
  - name: Webhooks
  - name: Platform
paths:
  /onboarding:
    patch:
      tags:
        - Onboarding
      summary: Skip setup steps
      description: >-
        Skips steps, or brings them back, as the dashboard's setup guide does. A
        skipped step no longer counts as missing.
      operationId: updateOnboarding
      parameters:
        - name: LobbyStack-Business
          in: header
          description: >-
            The business a platform key acts on. Required with a platform key. A
            per-business key may leave it out; if it sends one, it must be the
            key's own business.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingUpdate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Onboarding'
        '400':
          description: >-
            The request is invalid (invalid_request), or a platform key sent no
            LobbyStack-Business header (business_required).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, invalid, or revoked (unauthorized).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Refused. insufficient_scope: the key lacks the business:write scope.
            forbidden: a per-business key named another business in
            LobbyStack-Business. key_owner_inactive: the person the key acts for
            can't any more: a per-business key's creator is no longer an owner
            or admin, or a platform key's owner_email has no verified LobbyStack
            account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: A platform key named a business it cannot act on (not_found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The request conflicts with the current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Too many requests (rate_limited). Wait for the Retry-After header's
            number of seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
      security:
        - bearerAuth: []
components:
  schemas:
    OnboardingUpdate:
      type: object
      properties:
        skip_steps:
          maxItems: 4
          type: array
          items:
            type: string
            enum:
              - knowledge
              - phone_number
              - full_site_read
              - test_call
          description: >-
            The steps to skip, out of knowledge, phone_number, full_site_read
            and test_call. The list replaces the one before, so a step left out
            is no longer skipped.
      required:
        - skip_steps
      additionalProperties: false
    Onboarding:
      type: object
      properties:
        stage:
          type: string
          description: >-
            The step the dashboard's onboarding shows, for example website,
            phone_number or complete. The API doesn't follow these steps in
            order.
        complete:
          type: boolean
          description: >-
            true once onboarding is finished, so the dashboard opens on the
            business itself.
        checklist:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                enum:
                  - business_details
                  - knowledge
                  - greeting
                  - plan
                  - phone_number
                  - full_site_read
                  - test_call
                description: >-
                  business_details: a name and time zone. knowledge: a website
                  or knowledge the receptionist answers from. greeting: a
                  greeting, the default one included; change it with PATCH
                  /receptionist. plan: a paid plan. phone_number: a live number.
                  full_site_read: the whole website read, beyond the first
                  sample, and done when there is no website. test_call: a call
                  the receptionist answered.
              status:
                type: string
                enum:
                  - done
                  - missing
                  - skipped
                description: >-
                  skipped: left out through PATCH /onboarding or the dashboard's
                  setup guide. A business on the free plan, or self-hosted,
                  shows plan as skipped.
              required:
                type: boolean
                description: >-
                  true when POST /onboarding/complete needs this done or
                  skipped: the business details, and a phone number on a paid
                  plan.
            required:
              - id
              - status
              - required
            additionalProperties: false
        missing:
          type: array
          items:
            type: string
            enum:
              - business_details
              - knowledge
              - greeting
              - plan
              - phone_number
              - full_site_read
              - test_call
          description: >-
            Required items neither done nor skipped, and empty once onboarding
            is complete. POST /onboarding/complete refuses while any is missing;
            skip_number covers phone_number.
      required:
        - stage
        - complete
        - checklist
        - missing
      additionalProperties: false
      description: How far the business is in setting up its receptionist.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - insufficient_scope
                - not_found
                - conflict
                - idempotency_key_reused
                - idempotency_request_in_progress
                - booking_disabled
                - booking_requires_confirmation
                - slot_unavailable
                - rate_limited
                - rate_limit_unavailable
                - method_not_allowed
                - internal_error
                - business_required
                - key_owner_inactive
                - plan_limit_reached
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                  - path
                  - message
                additionalProperties: false
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Settings > API keys (lsk_...), which acts on its own
        business, or a platform key from the PLATFORM_API_KEYS setting
        (lsp_...), which onboards and manages businesses. Scopes: business:read,
        business:write, calls:read, contacts:read, contacts:write,
        appointments:read, appointments:write, messages:read, knowledge:read,
        knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage,
        team:manage, businesses:create, users:create. Only platform keys can
        hold businesses:create and users:create.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.