> ## 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. # Update an area > Edits an area. Send only what changes; an omitted field is left alone. Setting `status` to `maintenance` or `inactive`, or narrowing `visibility`, takes the area out of availability - which is the durable way to close a court indefinitely, where an area block closes it for a stated window. Any edit to hours, status, visibility, capacity or area type writes an `availability_changes` entry alongside the row, so partners see it on their next reconciliation. `clubId` is not editable: moving a court to another club would strand its bookings, class holds and blocks at the old one. There is no delete either - an area carries booking history, so close it with `status` instead. Supports the `Idempotency-Key` header. ## OpenAPI ````yaml /openapi-platform.json patch /v1/platform/areas/{areaId} 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/areas/{areaId}: patch: tags: - Areas summary: Update an area description: > Edits an area. Send only what changes; an omitted field is left alone. Setting `status` to `maintenance` or `inactive`, or narrowing `visibility`, takes the area out of availability - which is the durable way to close a court indefinitely, where an area block closes it for a stated window. Any edit to hours, status, visibility, capacity or area type writes an `availability_changes` entry alongside the row, so partners see it on their next reconciliation. `clubId` is not editable: moving a court to another club would strand its bookings, class holds and blocks at the old one. There is no delete either - an area carries booking history, so close it with `status` instead. Supports the `Idempotency-Key` header. parameters: - in: path name: areaId required: true schema: type: integer description: Area id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformAreaUpdate' responses: '200': description: The updated area 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' '404': $ref: '#/components/responses/PlatformNotFound' '429': $ref: '#/components/responses/PlatformRateLimited' security: - customerApiAuth: [] components: schemas: PlatformAreaUpdate: type: object description: >- Fields accepted when updating an area. Send only what changes; an omitted field is left alone. At least one field is required, and unknown fields are rejected. `clubId` is absent on purpose - moving a court to another club would strand its bookings, class holds and blocks at the old one. minProperties: 1 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. visibility: type: string enum: - Private - Member_only - 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: 1 description: >- How many bookings may hold the area at the same time. 1 for an ordinary court. 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 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 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' PlatformNotFound: description: The requested resource does not exist in this organization 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. ````