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

> Adds a kind of space the organization books. List the existing types first: an organization is seeded with one per sport its clubs offer, and a second "Padel court" splits inventory that should be one group.

`sports` is what makes areas of this type bookable for a sport at all, and it is canonicalized - send `padel`, not `Padel`. An unknown sport is refused rather than stored as a value nothing will match. `slug` is optional and derived from the name when omitted. Supports the `Idempotency-Key` header.




## OpenAPI

````yaml /openapi-platform.json post /v1/platform/area-types
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.


    ## 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 |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/area-types:
    post:
      tags:
        - Areas
      summary: Create an area type
      description: >
        Adds a kind of space the organization books. List the existing types
        first: an organization is seeded with one per sport its clubs offer, and
        a second "Padel court" splits inventory that should be one group.


        `sports` is what makes areas of this type bookable for a sport at all,
        and it is canonicalized - send `padel`, not `Padel`. An unknown sport is
        refused rather than stored as a value nothing will match. `slug` is
        optional and derived from the name when omitted. Supports the
        `Idempotency-Key` header.
      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/PlatformAreaTypeCreate'
      responses:
        '201':
          description: Area type created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformAreaType'
        '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'
        '409':
          description: An explicit `slug` is already used by another area type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformAreaTypeCreate:
      type: object
      description: >-
        Fields accepted when creating an area type. Only `name` is required;
        `slug` is derived from it when omitted, and suffixed if that is taken.
        The defaults shown are what an omitted field becomes, and unknown fields
        are rejected.
      required:
        - name
      properties:
        name:
          type: string
          maxLength: 255
        slug:
          type: string
          maxLength: 120
          pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
          description: >-
            Stable key. Derived from the name when omitted; send one only when
            something outside 1club already refers to it. An explicit slug that
            clashes is a 409, and a rename never moves it.
        description:
          type: string
          nullable: true
          maxLength: 2000
        revenueAccountId:
          type: integer
          nullable: true
          description: >-
            Where a booking on this kind of area posts, from GET
            /v1/platform/revenue-accounts. Leave it unset and the sale posts to
            whichever account the organization has marked default, resolved at
            the time of the sale.
        sports:
          type: array
          maxItems: 20
          items:
            type: string
          description: >-
            Canonical sport ids an area of this type can be booked for, e.g.
            ["padel"]. This is what makes the areas bookable for a sport at all;
            an unrecognised value is rejected rather than stored.
        isBookable:
          type: boolean
          default: true
          description: >-
            False for a kind of space that is not booked at all (a storeroom, a
            corridor).
        defaultPricePerHour:
          type: number
          nullable: true
          minimum: 0
          description: >-
            Hourly price an area of this type starts from. An area may override
            it.
        defaultMaxPlayers:
          type: integer
          nullable: true
          minimum: 1
          maximum: 1000
          description: How many people a slot on this type normally takes.
        maxConcurrentBookings:
          type: integer
          minimum: 1
          maximum: 100
          default: 1
          description: >-
            How many bookings may hold an area of this type at once. 1 for an
            ordinary court.
    PlatformAreaType:
      type: object
      description: >-
        A kind of area, and the defaults every area of that kind inherits. One
        shape for the list, get-by-id, create and update.
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
          description: >-
            Stable key, derived from the name when a create does not send one. A
            rename never moves it.
        description:
          type: string
          nullable: true
        revenueAccountId:
          type: integer
          nullable: true
          description: >-
            Where a booking on this kind of area posts. Null falls back to the
            organization's default account.
        areaCount:
          type: integer
          description: Areas currently of this type, whatever their status.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        sports:
          type: array
          items:
            type: string
          description: Sports an area of this type can be booked for.
        isBookable:
          type: boolean
          description: >-
            False for a type that is not booked at all (a storeroom, a
            corridor). Do not build bookable inventory on one.
        defaultPricePerHour:
          type: number
          nullable: true
          description: >-
            Hourly price an area of this type starts from; an area may override
            it.
        defaultMaxPlayers:
          type: integer
          nullable: true
          description: How many people a slot on this type normally takes.
        maxConcurrentBookings:
          type: integer
          description: >-
            How many bookings may hold an area of this type at once. 1 for an
            ordinary court.
    PlatformError:
      type: object
      properties:
        error:
          type: string
  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.

````