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

# Update a booth

> Hold, reserve, sell, block or release a booth, assign it to an exhibitor or sponsor,
set its own price, or move it to another booth package. Send only the fields to
change.

- `available` releases the booth: its account and hold are cleared, unless you send
  an `account_id` in the same request.
- `reserved` and `sold` need an account — the one already on the booth, or
  `account_id`.
- `hold` with `hold_until` keeps the booth for the account until then; after that the
  booth reads `available`.
- `account_id: null` removes the account.

`account_id` must be an exhibitor or sponsor of this event. `product_id` must be a
booth package of this event (a ticket type of type `booth`); the booth moves into that
package and out of any other. `product_id: null` takes it out of every package.

Recorded in the event's History as an API change. Requires `write:expo`.




## OpenAPI

````yaml /api-reference/openapi.yaml put /v1/event/{eventId}/booths/{boothId}
openapi: 3.1.0
info:
  title: Sessionboard Public API
  version: '1.0'
  description: >-
    REST API for managing sessions, speakers, contacts, sponsors, exhibitors,
    and event data on the Sessionboard platform.
  contact:
    name: Sessionboard Support
    email: support@sessionboard.com
  termsOfService: https://www.sessionboard.com/legal/terms-of-service
servers:
  - url: https://public-api.sessionboard.com
    description: US Region
  - url: https://public-api-eu.sessionboard.com
    description: EU Region
security:
  - ApiKey: []
  - BearerToken: []
tags:
  - name: Events
    description: Manage events on the platform.
  - name: Sessions
    description: Search and retrieve sessions within an event.
  - name: Session Writes
    description: >-
      Create, update, delete, and restore sessions. Requires the
      `write:sessions` scope.
  - name: Contact Writes
    description: >-
      Create, update, delete, and restore contacts. Requires the
      `write:contacts` scope.
  - name: Exhibitor Writes
    description: >-
      Create, update, delete, and restore exhibitors. Requires the
      `write:exhibitors` scope.
  - name: Sponsor Writes
    description: >-
      Create, update, delete, and restore sponsors. Requires the
      `write:sponsors` scope.
  - name: Field Writes
    description: >-
      Create, update, and delete custom fields. Requires the `write:fields`
      scope.
  - name: Speakers
    description: Search and retrieve speakers within an event.
  - name: Participants
    description: |
      Search and retrieve every contact holding a session role on an event —
      speakers, chairpersons, moderators and custom roles — with the roles
      each one holds, and list the event's participant roles.
  - name: Contacts
    description: Search and retrieve contacts at the organization or event level.
  - name: Sponsors
    description: Search and retrieve sponsors within an event.
  - name: Exhibitors
    description: Search and retrieve exhibitors within an event.
  - name: Event Settings
    description: >-
      Retrieve event configuration such as fields, tags, tracks, rooms, formats,
      levels, languages, and session statuses.
  - name: GDPR
    description: Manage GDPR data access and erasure requests.
  - name: Insights
    description: >-
      Query event data using SbQL, generate queries with AI, and manage
      dashboards.
  - name: Ask
    description: >-
      Ask a natural-language question about one event and get a cited answer.
      Requires the `read:ask` scope, granted explicitly.
  - name: Metadata Writes
    description: >-
      Create, update, and delete session metadata (rooms, tracks, tags, formats,
      levels, languages, statuses). Requires the `write:metadata` scope.
  - name: Agenda Planning
    description: >-
      Manage agenda drafts, draft sessions, scheduling rules, and evaluation
      personas. Requires the `write:events` scope.
  - name: Dashboards & Widgets
    description: >-
      Create, read, update, and delete dashboards and widgets at the event or
      organization level. Requires `write:events` scope for writes.
  - name: Reports & Queries
    description: >-
      Create, read, update, delete, and run saved SbQL queries/reports at the
      event or organization level. Requires `write:events` scope for writes.
  - name: Transcriptions
    description: >-
      Transcript text on sessions — fragments, summaries, insights, and
      translations. Requires `read:transcriptions` / `write:transcriptions`
      scopes.
  - name: Session Recordings
    description: >-
      Session audio files for recording archives (live capture or imported
      audio). Requires `read:transcriptions` / `write:transcriptions` scopes.
  - name: Media
    description: >-
      Upload video or audio files for automatic transcription. Requires
      `read:media` / `write:media` scopes.
  - name: Session Files
    description: >
      Documents attached to sessions (PDFs, PowerPoint, Word, images, and
      similar).

      Simple upload: `POST .../files/upload` (multipart, max 50 MB).

      Direct-to-storage: create → PUT → complete (max 500 MB).

      Requires `read:sessions` / `write:sessions` scopes.

      See the [Uploading session files](/guides/uploading-session-files) guide.
  - name: OAuth
    description: >-
      OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted
      at `/oauth/` (not `/v1/`).
  - name: Log Export
    description: >
      Pull your organization's API request, security and audit logs into a SIEM

      such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API
      token

      with the `read:audit_logs` scope, which can call nothing else.

      See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem)
      guide.
  - name: Awards
    description: >-
      Read and manage Awards programs and their categories, rounds, promo codes,
      submissions and reviews. Organization-level: paths start at
      `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards`
      scopes.
  - name: Registration
    description: >
      Registration inside Sessionboard: registration forms, ticket types,
      registrations,

      orders, attendees and check-ins for one event. Requires the preview scopes

      `read:registrations` / `write:registrations`, which a token or OAuth
      client gets only

      when they are named explicitly (not by default, and not listed in
      `scopes_supported`).

      The event must have Registration turned on (Early Access); otherwise every
      endpoint

      answers `403 FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
  - name: Expo
    description: >
      Expo floor-map booths and sponsorship inventory for one event. Requires
      the preview

      scopes `read:expo` / `write:expo`, which a token or OAuth client gets only
      when they are

      named explicitly (not by default, and not listed in `scopes_supported`).
      The event must

      have Expo turned on (Early Access); otherwise every endpoint answers `403
      FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
paths:
  /v1/event/{eventId}/booths/{boothId}:
    put:
      tags:
        - Expo
      summary: Update a booth
      description: >
        Hold, reserve, sell, block or release a booth, assign it to an exhibitor
        or sponsor,

        set its own price, or move it to another booth package. Send only the
        fields to

        change.


        - `available` releases the booth: its account and hold are cleared,
        unless you send
          an `account_id` in the same request.
        - `reserved` and `sold` need an account — the one already on the booth,
        or
          `account_id`.
        - `hold` with `hold_until` keeps the booth for the account until then;
        after that the
          booth reads `available`.
        - `account_id: null` removes the account.


        `account_id` must be an exhibitor or sponsor of this event. `product_id`
        must be a

        booth package of this event (a ticket type of type `booth`); the booth
        moves into that

        package and out of any other. `product_id: null` takes it out of every
        package.


        Recorded in the event's History as an API change. Requires `write:expo`.
      operationId: update-booth
      parameters:
        - $ref: '#/components/parameters/EventId'
        - name: boothId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The booth ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BoothUpdateRequest'
            examples:
              hold:
                summary: Hold for an exhibitor for a week
                value:
                  status: hold
                  account_id: e1d2c3b4-a5f6-4789-8a9b-0c1d2e3f4a5b
                  hold_until: '2026-11-03T23:59:00Z'
              release:
                summary: Release
                value:
                  status: available
      responses:
        '200':
          description: The booth after the change, in the same shape as the list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Booth'
        '400':
          description: >
            `VALIDATION_ERROR`:

            - `boothId` or `account_id` is not a UUID.

            - `status` is not `available`, `hold`, `reserved`, `sold` or
            `blocked`.

            - `account_id` is not an exhibitor or sponsor of this event.

            - `hold_until` is not an ISO date or `null`.

            - `list_price_cents` is not a non-negative integer or `null`.

            - `product_id` is not a booth package of this event.

            - `reserved` or `sold` without an account (`details.reason:
            account_required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
              example:
                error: VALIDATION_ERROR
                message: Pick the exhibitor this booth goes to.
                details:
                  reason: account_required
        '401':
          $ref: '#/components/responses/RegistrationUnauthorized'
        '403':
          $ref: '#/components/responses/ExpoForbidden'
        '404':
          description: >-
            `NOT_FOUND` — no such booth on this event (`details.reason:
            booth_not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
        '429':
          $ref: '#/components/responses/RegistrationTooManyRequests'
components:
  parameters:
    EventId:
      name: eventId
      in: path
      required: true
      schema:
        type: integer
      description: Event ID
  schemas:
    BoothUpdateRequest:
      type: object
      properties:
        status:
          type: string
          enum:
            - available
            - hold
            - reserved
            - sold
            - blocked
        account_id:
          type:
            - string
            - 'null'
          format: uuid
          description: An exhibitor or sponsor of this event; `null` removes the account.
        hold_until:
          type:
            - string
            - 'null'
          format: date-time
          description: Until when a `hold` lasts; `null` clears it.
        list_price_cents:
          type:
            - integer
            - 'null'
          minimum: 0
          description: >-
            The booth's own price in cents; `null` falls back to its package
            price.
        product_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The booth package (a ticket type of type `booth`) to sell this booth
            in; `null` removes it from every package.
    Booth:
      type: object
      properties:
        id:
          type: string
          format: uuid
        floor_map_id:
          type: string
          format: uuid
        hall_id:
          type: string
          format: uuid
        number:
          type: string
        status:
          type: string
          enum:
            - available
            - hold
            - reserved
            - sold
            - blocked
          description: The status now — an expired `hold` reads `available`.
        stored_status:
          type: string
          enum:
            - available
            - hold
            - reserved
            - sold
            - blocked
          description: The status as last set.
        booth_type:
          type: string
          description: For example `linear`.
        list_price_cents:
          type:
            - integer
            - 'null'
          description: The booth's own price, when set; overrides its package price.
        price_cents:
          type:
            - integer
            - 'null'
          description: '`list_price_cents`, or else the booth package price.'
        currency:
          type: string
        hold_until:
          type:
            - string
            - 'null'
          format: date-time
        geom:
          type: object
          additionalProperties: true
          description: The booth's shape and position on the floor map.
        fill_color:
          type:
            - string
            - 'null'
        product:
          type:
            - object
            - 'null'
          description: >-
            The booth package (a ticket type of type `booth`) that sells this
            booth.
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            price_cents:
              type: integer
        account:
          type:
            - object
            - 'null'
          description: The exhibitor or sponsor holding the booth.
          properties:
            id:
              type: string
              format: uuid
            name:
              type:
                - string
                - 'null'
        application_id:
          type:
            - string
            - 'null'
          description: >-
            The exhibitor booth application this booth was assigned through, if
            any.
        order_id:
          type:
            - string
            - 'null'
          description: The order of that application, if any.
    RegistrationApiError:
      type: object
      description: Error body of the Registration and Expo endpoints.
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - VALIDATION_ERROR
            - NOT_FOUND
            - FORBIDDEN
            - CONFLICT
            - SCOPE_REQUIRED
            - EVENT_NOT_ALLOWED
            - EVENT_ARCHIVED
            - INTERNAL_ERROR
        message:
          type: string
        details:
          type: object
          description: Present when there is a machine-readable reason.
          properties:
            reason:
              type: string
              description: >
                Why the request was refused, for example `duplicate`,
                `sold_out`, `too_many`,

                `ticket_unavailable`, `not_on_sale`,
                `registrant_type_unavailable`,

                `answers_invalid`, `discount_invalid`, `wrong_status`,
                `account_required` or

                `booth_not_found`.
            status:
              type: string
              description: >-
                For `wrong_status` on Check someone in, the registration's
                current status.
            errors:
              type: object
              additionalProperties: true
              description: >-
                More detail for some reasons — the email for `duplicate`, the
                `ticket_type_id` for `sold_out`, the problems per answer for
                `answers_invalid`.
  responses:
    RegistrationUnauthorized:
      description: >-
        Missing, invalid or expired token, or the event does not belong to your
        organization.
    ExpoForbidden:
      description: >
        - `SCOPE_REQUIRED` — the token lacks the scope (`read:expo` for reads,
        `write:expo` for writes). A write scope does not grant reads, and legacy
        tokens with no scopes cannot write.

        - `EVENT_NOT_ALLOWED` — the event is outside the token's event
        allow-list.

        - `EVENT_ARCHIVED` — the event is archived.

        - `FORBIDDEN` — Expo is not turned on for this event.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegistrationApiError'
          example:
            error: FORBIDDEN
            message: Expo is not enabled for this event
    RegistrationTooManyRequests:
      description: |
        The token's request limit (100 requests per 15 minutes per bucket — see
        [Rate Limiting](/rate-limiting)). Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-access-token
      description: >-
        Organization API token. Generate from Organization Settings → API
        Tokens.
    BearerToken:
      type: http
      scheme: bearer
      description: >-
        OAuth 2.1 access token. Obtained via the OAuth PKCE flow at
        `/oauth/token`.

````

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