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

> Adds a kind of class the organization runs. List the existing types first - a club rarely wants two types meaning the same thing, and this endpoint will happily create a duplicate name.

`slug` is optional and derived from the name when omitted, suffixed if that is taken. Send one explicitly only when something outside 1club already refers to it; an explicit slug that clashes is a 409 rather than a row quietly filed under a different key. Supports the `Idempotency-Key` header.




## OpenAPI

````yaml /openapi-platform.json post /v1/platform/class-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/class-types:
    post:
      tags:
        - Classes
      summary: Create a class type
      description: >
        Adds a kind of class the organization runs. List the existing types
        first - a club rarely wants two types meaning the same thing, and this
        endpoint will happily create a duplicate name.


        `slug` is optional and derived from the name when omitted, suffixed if
        that is taken. Send one explicitly only when something outside 1club
        already refers to it; an explicit slug that clashes is a 409 rather than
        a row quietly filed under a different key. 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/PlatformClassTypeCreate'
      responses:
        '201':
          description: Class type created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformClassType'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `classes:write` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '409':
          description: An explicit `slug` is already used by another class type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformClassTypeCreate:
      type: object
      description: >-
        Fields accepted when creating a class 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 sale on this kind of class 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.
        maxPartySize:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1
          description: How many people one booking may bring, including the booker.
        allowMultiDay:
          type: boolean
          default: false
          description: >-
            Whether a class of this kind may run across more than one calendar
            day.
        cancelIfAttendanceZero:
          type: boolean
          default: false
          description: Whether a class with nobody booked cancels itself.
        cancelIfAttendanceZeroHoursInAdvance:
          type: integer
          minimum: 0
          maximum: 720
          default: 0
          description: >-
            Hours before the start that cancellation runs. Meaningless unless
            `cancelIfAttendanceZero`.
        bookingAudience:
          $ref: '#/components/schemas/PlatformContactAudience'
    PlatformClassType:
      type: object
      description: >-
        A kind of class the organization runs. Reference the `id` as
        `classTypeId` on a class, or in `classTypeIds` on a class pay rate
        policy. 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 sale on this kind of class posts. Null falls back to the
            organization's default account.
        classCount:
          type: integer
          description: Classes currently run as this type, past and future.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        maxPartySize:
          type: integer
          description: >-
            How many people one booking on a class of this kind may bring,
            including the booker.
        allowMultiDay:
          type: boolean
          description: >-
            Whether a class of this kind may run across more than one calendar
            day.
        cancelIfAttendanceZero:
          type: boolean
          description: Whether a class with nobody booked cancels itself.
        cancelIfAttendanceZeroHoursInAdvance:
          type: integer
          description: >-
            Hours before the start that cancellation runs. Meaningless unless
            `cancelIfAttendanceZero`.
        bookingAudience:
          $ref: '#/components/schemas/PlatformContactAudience'
    PlatformError:
      type: object
      properties:
        error:
          type: string
    PlatformContactAudience:
      type: object
      description: >-
        Who something applies to, as a set of predicates a contact must match.
        `null` means everybody. The same shape a promotion segment and an
        automation entry condition use. `membershipPlanIds` is which plan the
        contact must HOLD, not which plan a purchase discounts.
      nullable: true
      properties:
        memberTypes:
          type: array
          maxItems: 20
          items:
            type: string
          description: Values of the contact's `type`, e.g. `member`, `lead`.
        tags:
          type: array
          maxItems: 50
          items:
            oneOf:
              - type: string
                maxLength: 100
              - type: integer
          description: Tag ids or names the contact carries.
        membershipPlanIds:
          type: array
          maxItems: 50
          items:
            type: integer
          description: Membership plans the contact must hold, from GET /v1/platform/plans.
        membershipPlanCategoryIds:
          type: array
          maxItems: 50
          items:
            type: integer
          description: Plan categories the contact must hold a plan in.
  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.

````