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

# Hold a slot

> Claims a quoted slot’s capacity until `expires_at` (see the location’s `hold_ttl_seconds`), so the party can be booked with `POST /bookings`. The location is the one the token was quoted for and must be granted to the app. A slot whose capacity is gone answers 409 `slot_unavailable`; a tampered or stale token 400 `invalid_slot_token` / `expired_slot_token`. Each app may have ten live or pending holds per location, enforced atomically for native and provider holds. All hold IDs use bkh_; only the creating app can release or consume them. Over quota answers 429 with retry_after and Retry-After. Pending provider acquisitions answer 409 operation_in_progress; replay the same token. Requires `bookings:write`.



## OpenAPI

````yaml /openapi/developer-api.json post /booking_holds
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, venue verbs, configuration, and live floor.
  - name: Webhooks
    description: Event-type catalog, subscriptions, the event ledger, and replay.
paths:
  /booking_holds:
    post:
      tags:
        - Bookings
      summary: Hold a slot
      description: >-
        Claims a quoted slot’s capacity until `expires_at` (see the location’s
        `hold_ttl_seconds`), so the party can be booked with `POST /bookings`.
        The location is the one the token was quoted for and must be granted to
        the app. A slot whose capacity is gone answers 409 `slot_unavailable`; a
        tampered or stale token 400 `invalid_slot_token` / `expired_slot_token`.
        Each app may have ten live or pending holds per location, enforced
        atomically for native and provider holds. All hold IDs use bkh_; only
        the creating app can release or consume them. Over quota answers 429
        with retry_after and Retry-After. Pending provider acquisitions answer
        409 operation_in_progress; replay the same token. Requires
        `bookings:write`.
      operationId: developer-api-bookings.createBookingHold
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                slot_token:
                  type: string
                  description: >-
                    A `slot_token` from a booking availability search,
                    unchanged.
              required:
                - slot_token
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - booking_hold
                  id:
                    type: string
                    description: >-
                      Opaque. `bkh_…` for a hold in Maple’s ledger; at a
                      provider-managed location, the provider’s own hold token.
                      Round-trip it unchanged.
                  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
                  starts_at:
                    type: string
                    description: ISO-8601 UTC instant of the held slot.
                  party_size:
                    anyOf:
                      - anyOf:
                          - type: number
                          - type: string
                            enum:
                              - NaN
                          - type: string
                            enum:
                              - Infinity
                          - type: string
                            enum:
                              - '-Infinity'
                      - type: string
                        enum:
                          - Infinity
                          - '-Infinity'
                          - NaN
                  expires_at:
                    type: string
                    description: >-
                      ISO-8601 UTC instant after which the hold no longer claims
                      capacity.
                required:
                  - object
                  - id
                  - livemode
                  - created
                  - location_id
                  - starts_at
                  - party_size
                  - expires_at
                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'
        '409':
          description: DeveloperApiConflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiConflict'
        '422':
          description: DeveloperApiUnprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnprocessable'
        '429':
          description: DeveloperApiRateLimited
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DeveloperApiRateLimited1'
                  - $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
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnauthorized
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiForbidden
        code:
          type: string
          enum:
            - insufficient_scope
            - wrong_environment
        message:
          type: string
      required:
        - _tag
        - code
        - message
      additionalProperties: false
    DeveloperApiNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiNotFound
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiConflict:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiConflict
        code:
          type: string
        message:
          type: string
        details:
          type: object
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiUnprocessable:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnprocessable
        code:
          type: string
        message:
          type: string
        details:
          type: object
      required:
        - _tag
        - code
        - message
      additionalProperties: false
    DeveloperApiRateLimited1:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiRateLimited
        message:
          type: string
        retry_after:
          anyOf:
            - anyOf:
                - type: number
                - type: string
                  enum:
                    - NaN
                - type: string
                  enum:
                    - Infinity
                - type: string
                  enum:
                    - '-Infinity'
            - type: string
              enum:
                - Infinity
                - '-Infinity'
                - NaN
      required:
        - _tag
        - message
        - retry_after
      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'
      required:
        - _tag
        - message
        - retry_after
      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.

````