> ## 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.

# Make a prospect demo

> Makes a demo receptionist from a prospect's website, under the partner's brand, and returns its link once. The demo reads the website first: poll GET /partner/demos/{demo_id} until ready says everything is, then publish it. The partner needs a subdomain or its own domain first, or it's a 409. This endpoint ignores Idempotency-Key, so LobbyStack never stores a copy of the link; after a network error, look in GET /partner/demos before you retry. A partner's keys can make 30 demos an hour between them.



## OpenAPI

````yaml /api-reference/openapi.json post /partner/demos
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: Agents
  - 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
  - name: Partner
paths:
  /partner/demos:
    post:
      tags:
        - Partner
      summary: Make a prospect demo
      description: >-
        Makes a demo receptionist from a prospect's website, under the partner's
        brand, and returns its link once. The demo reads the website first: poll
        GET /partner/demos/{demo_id} until ready says everything is, then
        publish it. The partner needs a subdomain or its own domain first, or
        it's a 409. This endpoint ignores Idempotency-Key, so LobbyStack never
        stores a copy of the link; after a network error, look in GET
        /partner/demos before you retry. A partner's keys can make 30 demos an
        hour between them.
      operationId: createPartnerDemo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerDemoCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/PartnerDemoCreated'
        '400':
          description: The request is invalid (invalid_request).
          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 partner.demos:write
            scope. forbidden: only a partner's platform keys can call this
            endpoint, or what only the partner's owners may do.
            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'
        '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:
    PartnerDemoCreate:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
          description: The prospect's business name.
        website_url:
          type: string
          maxLength: 2000
          format: uri
          description: The prospect's website, which the demo reads.
        access_level:
          description: >-
            What the business's own team gets once someone claims the demo.
            Defaults to full.
          type: string
          enum:
            - full
            - activity
        locale:
          description: The language the demo's receptionist speaks first. Defaults to en.
          type: string
          enum:
            - en
            - fr
            - es
            - sr
            - de
            - pt
            - it
            - nl
            - pl
            - tr
            - vi
            - tl
            - sv
            - ru
            - uk
        greeting:
          type: string
          maxLength: 500
        timezone:
          description: IANA time zone, for example America/Toronto.
          type: string
          maxLength: 80
        suggested_prompts:
          description: >-
            What the demo page suggests the prospect ask. Publishing needs at
            least two.
          maxItems: 6
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 200
      required:
        - name
        - website_url
      additionalProperties: false
    PartnerDemoCreated:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Stable identifier (UUID).
        business_id:
          type: string
          format: uuid
          description: Stable identifier (UUID).
        status:
          type: string
          const: preparing
        access_level:
          type: string
          enum:
            - full
            - activity
        token:
          type: string
          description: >-
            The demo link's token. Publishing needs it. It's shown only here and
            by POST /partner/demos/{demo_id}/rotate.
        url:
          type: string
          description: >-
            The demo page on the partner's domain. Send it to the prospect once
            the demo is published.
      required:
        - id
        - business_id
        - status
        - access_level
        - token
        - url
      additionalProperties: false
    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
                - phone_numbers_unavailable
            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, phone_numbers:purchase,
        partner:read, partner.businesses:write, partner.demos:write,
        partner.packages:write, partner.branding:write, partner.templates:write,
        partner.team:write, partner.billing:read, partner.billing:write. Only
        platform keys can hold businesses:create and users:create, and only a
        key a partner made in its console can hold the partner scopes, which the
        Partner endpoints use. Only a partner's owners grant
        partner.billing:read and partner.billing:write.

````

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