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

# Close the waitlist

> Stops remote parties from joining; parties already waiting stay in line. Idempotent. Returns the waitlist. Requires bookings:manage.



## OpenAPI

````yaml /openapi/developer-api.json post /locations/{locationId}/waitlist/close
openapi: 3.1.0
info:
  title: Maple Developer API
  version: 0.0.1
  description: >-
    Public API for POS and platform partners to integrate with Maple: granted
    locations and connections, the order loop (validation, notification,
    accept/deny, status updates), payment-link visibility, menu publishing, and
    HMAC-signed webhooks. Authenticate every request with a Bearer API key
    (`mpk_test_…` / `mpk_live_…`). The credential determines the environment:
    test-mode credentials only see test data, live-mode credentials only see
    live data.
servers:
  - url: https://api.maple.inc/v1
    description: Production
  - url: https://api.staging.maple.inc/v1
    description: Sandbox (development and testing)
security: []
tags:
  - name: General
    description: Service status and credential introspection.
  - name: Locations
    description: The restaurant locations your app has been granted access to.
  - name: Connections
    description: Become (or stop being) a granted location’s order receiver.
  - name: Menu
    description: Publish and read a connected location’s menu.
  - name: Delivery zones
    description: >-
      Manage a connected location’s delivery zones and check whether a
      coordinate is deliverable.
  - name: Orders
    description: 'The order loop: read orders, submit validation results, and decide orders.'
  - name: Bookings
    description: >-
      Bookings (rolling out per location): a location’s booking profile,
      availability, holds, bookings, walk-ins, venue verbs, configuration, and
      live floor.
  - name: Waitlist
    description: >-
      A Maple-native location’s walk-up waitlist: the queue and wait estimate,
      joining, and venue actions.
  - name: Webhooks
    description: Event-type catalog, subscriptions, the event ledger, and replay.
  - name: Feedback
    description: >-
      Tell Maple about a bug, a missing capability, wrong docs, or an error you
      could not act on.
paths:
  /locations/{locationId}/waitlist/close:
    post:
      tags:
        - Waitlist
      summary: Close the waitlist
      description: >-
        Stops remote parties from joining; parties already waiting stay in line.
        Idempotent. Returns the waitlist. Requires bookings:manage.
      operationId: developer-api-waitlist.closeWaitlist
      parameters:
        - name: locationId
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - waitlist
                  location_id:
                    type: string
                  livemode:
                    type: boolean
                  open:
                    type: boolean
                    description: >-
                      Whether remote parties may join. The venue can still add
                      parties in person while it is closed.
                  entries:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - waitlist_entry
                        id:
                          type: string
                          description: Opaque, prefixed `bkw_…`.
                        livemode:
                          type: boolean
                        created:
                          anyOf:
                            - anyOf:
                                - type: number
                                - type: string
                                  enum:
                                    - NaN
                                - type: string
                                  enum:
                                    - Infinity
                                - type: string
                                  enum:
                                    - '-Infinity'
                            - type: string
                              enum:
                                - Infinity
                                - '-Infinity'
                                - NaN
                        location_id:
                          type: string
                        status:
                          type: string
                          enum:
                            - waiting
                            - notified
                            - on_my_way
                            - seated
                            - removed_by_guest
                            - removed_by_venue
                            - expired_no_response
                        party_size:
                          type: integer
                        position:
                          anyOf:
                            - type: integer
                            - type: 'null'
                          description: >-
                            1-based place in the queue while the entry is
                            active; null once it is seated, removed, or expired.
                        quoted_wait:
                          anyOf:
                            - type: object
                              properties:
                                parties_ahead:
                                  type: integer
                                wait_minutes:
                                  type: object
                                  properties:
                                    min:
                                      type: integer
                                    max:
                                      type: integer
                                  required:
                                    - min
                                    - max
                                  additionalProperties: false
                              required:
                                - parties_ahead
                                - wait_minutes
                              additionalProperties: false
                            - type: 'null'
                          description: >-
                            The wait quoted when the party joined, refreshed
                            when it is notified. Null when none could be quoted.
                        joined_at:
                          type: string
                          description: ISO-8601 UTC instant.
                        notified_at:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: ISO-8601 UTC instant the table-ready text was sent.
                        booking_id:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: >-
                            The walk-in booking created when the party was
                            seated; read it with `GET /bookings/{bookingId}`.
                        channel:
                          type: string
                          description: >-
                            The channel the party joined on, e.g. `api_partner`,
                            `voice_ai`, `internal`.
                        guest:
                          type: object
                          properties:
                            first_name:
                              anyOf:
                                - type: string
                                - type: 'null'
                            last_name:
                              anyOf:
                                - type: string
                                - type: 'null'
                            phone:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: E.164, when the guest left one.
                            phone_last_four:
                              anyOf:
                                - type: string
                                - type: 'null'
                            email:
                              anyOf:
                                - type: string
                                - type: 'null'
                          required:
                            - first_name
                            - last_name
                            - phone
                            - phone_last_four
                            - email
                          additionalProperties: false
                      required:
                        - object
                        - id
                        - livemode
                        - created
                        - location_id
                        - status
                        - party_size
                        - position
                        - quoted_wait
                        - joined_at
                        - notified_at
                        - booking_id
                        - channel
                        - guest
                      additionalProperties: false
                    description: The active queue, first in line first.
                required:
                  - object
                  - location_id
                  - livemode
                  - open
                  - entries
                additionalProperties: false
        '400':
          description: DeveloperApiBadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiBadRequest'
        '401':
          description: DeveloperApiUnauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnauthorized'
        '403':
          description: DeveloperApiForbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiForbidden'
        '404':
          description: DeveloperApiNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiNotFound'
        '422':
          description: DeveloperApiUnprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnprocessable'
        '429':
          description: DeveloperApiRateLimited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiRateLimited'
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying; also returned as retry_after in
                the body.
              schema:
                type: integer
                minimum: 1
      security:
        - bearer: []
components:
  schemas:
    DeveloperApiBadRequest:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiBadRequest
        code:
          type: string
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnauthorized
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiForbidden
        code:
          type: string
          enum:
            - insufficient_scope
            - wrong_environment
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - code
        - message
        - feedback
      additionalProperties: false
    DeveloperApiNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiNotFound
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiUnprocessable:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnprocessable
        code:
          type: string
        message:
          type: string
        details:
          type: object
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - code
        - message
        - feedback
      additionalProperties: false
    DeveloperApiRateLimited:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiRateLimited
        message:
          type: string
        retry_after:
          anyOf:
            - type: number
            - type: string
              enum:
                - NaN
            - type: string
              enum:
                - Infinity
            - type: string
              enum:
                - '-Infinity'
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - retry_after
        - feedback
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        API key — `mpk_test_…` for the sandbox, `mpk_live_…` for production.
        Issued by Maple during partner onboarding.

````