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

# Create an area

> Adds a bookable area - a court, a studio, a lane - to one of the organization's clubs. `clubId` comes from GET /v1/platform/clubs and `areaTypeId` from GET /v1/platform/area-types; both must belong to this organization. The area type is what decides which sports the area can be booked for and what it is priced from, so resolve it first rather than guessing.

The new area enters partner availability feeds immediately, with an `availability_changes` entry written in the same transaction - so a partner reconciling against the change cursor sees the court appear.

Created areas default to `active` and `Public`. An area created `maintenance`, `inactive` or non-public is returned here and resolves by id, but will not appear in GET /v1/platform/areas, which lists only what is bookable today. Supports the `Idempotency-Key` header.

Needs `areas:write`, the same scope that blocks and unblocks areas. Existing grants therefore gain this the moment it ships; an OAuth connection made before it will not, because a grant expands the wildcard at consent time - reconnect to pick it up.




## OpenAPI

````yaml /openapi-platform.json post /v1/platform/areas
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    Agents and MCP connectors can instead send an OAuth access token (the
    `platformOAuth` scheme), requesting only the scopes the task needs.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |


    ## Versioning and deprecation


    The API is versioned in the path (`/v1`). Changes within a version are
    additive: new endpoints, new optional parameters and new response fields can
    appear at any time, so clients should ignore fields they do not recognise.

    A breaking change ships as a new version.

    An operation due to be removed is first marked `deprecated: true` in this
    spec and announced in the changelog at https://docs.1club.ai/changelog, with
    advance notice before it is withdrawn.
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
  - platformOAuth: []
tags: []
paths:
  /v1/platform/areas:
    post:
      tags:
        - Areas
      summary: Create an area
      description: >
        Adds a bookable area - a court, a studio, a lane - to one of the
        organization's clubs. `clubId` comes from GET /v1/platform/clubs and
        `areaTypeId` from GET /v1/platform/area-types; both must belong to this
        organization. The area type is what decides which sports the area can be
        booked for and what it is priced from, so resolve it first rather than
        guessing.


        The new area enters partner availability feeds immediately, with an
        `availability_changes` entry written in the same transaction - so a
        partner reconciling against the change cursor sees the court appear.


        Created areas default to `active` and `Public`. An area created
        `maintenance`, `inactive` or non-public is returned here and resolves by
        id, but will not appear in GET /v1/platform/areas, which lists only what
        is bookable today. Supports the `Idempotency-Key` header.


        Needs `areas:write`, the same scope that blocks and unblocks areas.
        Existing grants therefore gain this the moment it ships; an OAuth
        connection made before it will not, because a grant expands the wildcard
        at consent time - reconnect to pick it up.
      operationId: createArea
      parameters:
        - in: header
          name: Idempotency-Key
          schema:
            type: string
            maxLength: 255
          description: >-
            Retry-safe key; a repeat of the same request replays the first
            response
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformAreaCreate'
      responses:
        '201':
          description: Area created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformArea'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `areas:write` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformAreaCreate:
      type: object
      description: >-
        Fields accepted when creating an area. The defaults shown are what an
        omitted field becomes. Unknown fields are rejected.
      required:
        - name
        - clubId
        - areaTypeId
      properties:
        name:
          type: string
          maxLength: 255
        areaTypeId:
          type: integer
          description: >-
            From GET /v1/platform/area-types. Decides which sports the area is
            bookable for and what it is priced from, so resolve it rather than
            guessing.
        description:
          type: string
          nullable: true
          maxLength: 5000
        status:
          type: string
          enum:
            - active
            - maintenance
            - inactive
          description: >-
            Only an `active` area is bookable. `maintenance` and `inactive` take
            it out of availability without losing its history - this is how a
            court is closed indefinitely, where an area block closes it for a
            stated window.
          default: active
        visibility:
          type: string
          enum:
            - Private
            - Member_only
            - Public
          default: Public
        pricePerHour:
          type: number
          nullable: true
          minimum: 0
          description: >-
            Overrides the area type's default hourly price; null falls back to
            it.
        operatingHours:
          type: object
          description: >-
            Per-day-of-week opening schedule, in the club's timezone.
            Intersected with the club's own hours - an area is never bookable
            outside them.
          additionalProperties: true
        maxConcurrentBookings:
          type: integer
          minimum: 0
          description: >-
            How many bookings and classes may hold the area at the same time. 1
            for an ordinary court; 0 means unlimited (an open gym floor) and is
            the default for an area with no type.
        isDefault:
          type: boolean
          description: >-
            Make this the club's Default Area - the door-access area a check-in
            on a General Plan uses when the club has several active areas.
            `true` moves the flag off the club's previous default; `false`
            leaves the club with none.
        images:
          type: array
          maxItems: 5
          items:
            type: string
            format: uri
          description: >-
            The area's photos, shown on its website page and booking calendar.
            Absolute http(s) URLs, ideally from GET /v1/platform/media. Replaces
            the whole list.
        clubId:
          type: integer
          description: >-
            Club the area belongs to, from GET /v1/platform/clubs. Not editable
            afterwards.
    PlatformArea:
      type: object
      description: >-
        An area - a court, a studio, a lane. One shape for the list, get-by-id,
        create and update.
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
          nullable: true
        clubId:
          type: integer
        areaTypeId:
          type: integer
          nullable: true
          description: >-
            The kind of area, from GET /v1/platform/area-types. Decides `sports`
            and the default price.
        status:
          type: string
          enum:
            - active
            - maintenance
            - inactive
          description: >-
            Only an `active` area is bookable, and only those appear in the
            list. The other two resolve by id.
        visibility:
          type: string
          enum:
            - Private
            - Member_only
            - Public
          description: The list shows only `Public` areas; the others resolve by id.
        sports:
          type: array
          items:
            type: string
          description: Sports the area is bookable for, from its area type.
        pricePerHour:
          type: number
          nullable: true
        maxConcurrentBookings:
          type: integer
          description: Bookings and classes the area holds at once; 0 means unlimited.
        timezone:
          type: string
          description: >-
            IANA timezone the operating hours are expressed in (the club's,
            falling back to the organization's). Convert a local wall time in
            this zone when sending `startTime`/`endTime` to POST
            /v1/platform/bookings.
        operatingHours:
          type: object
          description: Per-day-of-week opening schedule
          additionalProperties: true
        isDefault:
          type: boolean
          description: >-
            Whether this is the club's Default Area. At most one per club; a
            club may have none.
        images:
          type: array
          items:
            type: string
          description: The area's photos, in display order.
    PlatformError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            A stable, machine-readable reason, when the error has one (e.g.
            `CONTACT_EXISTS`).
        details:
          type: object
          additionalProperties: true
          description: >-
            Structured values behind the error. A 409 naming an existing record
            carries its id here, e.g. `contactId`.
  responses:
    PlatformBadRequest:
      description: Invalid request (bad parameters, or a body that fails validation)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.
    platformOAuth:
      type: oauth2
      description: >-
        OAuth 2.1 authorization code flow with PKCE (S256), as used by MCP
        connectors. Register a client dynamically (RFC 7591) at
        https://api.1club.ai/v1/mcp/oauth/register. Each scope grants one
        capability; request only what the integration needs.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.1club.ai/oauth/authorize
          tokenUrl: https://api.1club.ai/v1/mcp/oauth/token
          scopes:
            '*': >-
              Full access - read and manage everything in this organization,
              including capabilities added later
            classes:read: View classes, class types, schedules and progression tracks
            classes:write: >-
              Create, reschedule, and cancel classes, and maintain the class
              types they are run as
            checkins:read: View check-ins
            checkins:write: Check people in, to a booking or on their membership
            content:read: View published content
            content:write: >-
              Create, edit and delete content - posts, FAQs, documents and
              reusable blocks
            website:read: >-
              View your website: pages, sections, layout, styles and publish
              history
            website:write: >-
              Edit your website - pages, sections, navigation and styles. Edits
              stay unpublished until published.
            website:publish: >-
              Publish your website, making unpublished edits visible to the
              public, and roll back to an earlier version
            media:read: View your media library
            media:write: >-
              Add images and videos to your media library and edit their names
              and descriptions
            media:delete: Permanently delete files from your media library
            clubs:read: View club information
            clubs:write: >-
              Edit your clubs' details - name, contact details, address, opening
              hours, amenities and sports. Live on your website, member portal,
              app and 1club.me at once; a club listed on 1club.me sends its
              listing's changes for review.
            transactions:read: View transactions, revenue reports and your chart of accounts
            transactions:write: >-
              Record revenue collected outside 1club, such as a marketplace
              payout for your bookings, and refunds of it. Nothing is charged to
              anyone.
            transactions:delete: >-
              Void unpaid charges so they are no longer owed, and delete ones
              raised by mistake. A never-paid pass whose last charge goes is
              cancelled with it. Paid charges cannot be voided or deleted, and
              an API key reaches only the charges of bookings it made.
            payments:write: >-
              Record a payment against what a member owes, with one of your own
              payment methods such as cash or a bank transfer, and charge a
              member's saved card for a charge. An API key reaches only the
              charges of bookings it made.
            invoices:read: >-
              View your invoices - who they were issued to, their amounts and
              status - and how much was invoiced over a period
            areas:read: View areas, area types, blocks and availability
            areas:write: >-
              Create and update areas and area types, and block or unblock an
              area
            bookings:read: View bookings
            bookings:write: >-
              Create, change, reschedule and cancel bookings, add or remove
              participants, and waive what a cancelled or missed booking still
              owes
            bookings:delete: >-
              Permanently delete bookings entered by mistake, with their unpaid
              charges, check-ins and players. A paid or invoiced booking cannot
              be deleted - cancel and refund it instead.
            contacts:read: >-
              View contacts, their tags and custom field values, and your sales
              pipeline stages and sources
            contacts:write: >-
              Create and update contacts and tag them, and maintain your tags,
              smart tag rules and contact custom fields
            contacts:delete: >-
              Archive contacts, which cancels their active memberships and all
              their future bookings. Separate from creating and updating because
              those cancellations are not undone by restoring the contact.
            instructors:read: >-
              View instructors, their availability, the staff roster and their
              time off
            instructors:write: >-
              Create and update instructors (coaches) and the instructor types
              they are grouped by, including what members pay for a one-to-one
              session and how you pay the coach, and manage the staff roster
              (shifts, rotations) and their time off. Does not grant
              admin-portal access: an instructor created this way has no login
              and is never invited to your staff portal.
            plans:read: View plans and pricing
            plans:write: Create, edit and delete plans and plan categories
            memberships:read: View memberships
            memberships:write: >-
              Sell memberships, set their price and whether they are paid, and
              pause, resume or cancel them
            products:read: >-
              View the product catalogue and its categories, including prices
              and how many are left to sell
            products:write: Create and edit products and product categories
            forms:read: >-
              View your forms and their questions, and how many people have
              completed each. Not the answers themselves.
            forms:write: >-
              Create and edit forms and their questions, including sign-up forms
              that sell your plans and products. Forms are public as soon as
              they are created or changed. Does not delete forms.
            organization:write: >-
              Change organization-wide settings, which take effect immediately.
              That includes which languages you offer, across your website, the
              member portal, the mobile app and email, and what your clubs call
              their booking cards (private training, group activities, areas)
              wherever members book.
            revenue-accounts:write: >-
              Add accounts to your chart of accounts and edit them, including
              which one sales post to by default. Reading the chart needs no
              scope of its own - any of plans, products or transactions admits
              it.
            pricing-rules:read: >-
              View pricing rules - the surcharges, discounts and set prices
              applied when a booking is priced - and quote what a booking would
              cost
            pricing-rules:write: >-
              Create, edit, turn off and delete pricing rules. Changes apply to
              every booking priced afterwards.
            booking-policies:read: >-
              View booking policies: cancellation and refund rules, payment
              timing and booking windows
            booking-policies:write: >-
              Create, edit, duplicate and delete booking policies. Changes apply
              to every booking they cover from then on.
            document-rules:read: >-
              View document rules - which members are asked to sign or accept
              which documents, such as waivers
            document-rules:write: >-
              Create, edit and delete document rules, which decide who must sign
              or accept a document and whether it is required for entry
            external-programs:read: >-
              View external programs - third parties such as MultiSport or a
              corporate wellness scheme that pay for members' visits - and what
              each covers
            external-programs:write: >-
              Create, edit and remove external programs, including what each
              pays per visit and which classes, areas and coaches it can be used
              for
            templates:read: View your email and SMS templates
            templates:write: Create, edit and delete email and SMS templates
            events:read: View events, their tickets and how many are sold
            events:write: >-
              Create, edit, duplicate and delete events, and publish, unpublish
              or cancel them. Cancelling an event also cancels its attendees'
              bookings.
            messages:read: >-
              View messages sent to and received from your members, and their
              delivery status
            messages:write: >-
              Prepare draft messages to members. Drafts are never sent from
              here: someone at your club reviews and sends them from 1club.
            analytics:read: >-
              View statistics over a period - revenue, bookings, check-ins, how
              full your classes, courts and coaches were, memberships added and
              cancelled, and new members - as totals, never the people or sales
              behind them
            payment-methods:write: >-
              Add, rename and remove the payment methods staff record by hand,
              such as cash or a bank transfer, and choose which ones members may
              pick when paying for a booking. Reading them needs no scope of its
              own - transactions:read admits it.
            staff:read: >-
              View your staff accounts, their roles, and what each role is
              allowed to do
            staff:write: >-
              Change a staff member's role, and what the manager, front desk and
              instructor roles are allowed to do. Only a signed-in person can
              use it, with the same limits as in 1club: an API key is always
              refused.
            notifications:read: >-
              View which notifications each role gets by default, and on which
              channels
            notifications:write: >-
              Change which notifications each role gets and on which channels,
              and apply those defaults to everyone in a role, replacing their
              own choices
            competitors:read: >-
              View the competitors you follow, their prices and Google ratings,
              and how your prices compare with the market
            competitors:write: >-
              Add, edit and remove the competitors you follow, and have their
              websites read again
            promotions:read: >-
              View your promotions - discounts and vouchers, their promo codes,
              dates and how often they were redeemed

````

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