> ## 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 instructor > Edits an instructor's bookable profile - their sports, their member-facing rate, their availability, who may book them. Send only what changes; an omitted field is left alone. Retire a coach with `isActive: false` and bring them back with `isActive: true`; there is no delete, because an instructor carries bookings, classes and pay history. Two invariants are applied on the way through, so read the response rather than assuming the payload landed verbatim: deactivating always retires `bookability` to `Admin_only`, and `bookability` never outruns `visibility` - making someone `Private` pulls a `Public` bookability down with it. `contactId` is not editable: the profile is bound to one person, and re-pointing it would silently transfer their bookings and their pay. The staff-portal fields are refused here for the same reasons as on the create. ## OpenAPI ````yaml /openapi-platform.json patch /v1/platform/instructors/{id} 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/instructors/{id}: patch: tags: - Instructors summary: Update an instructor description: > Edits an instructor's bookable profile - their sports, their member-facing rate, their availability, who may book them. Send only what changes; an omitted field is left alone. Retire a coach with `isActive: false` and bring them back with `isActive: true`; there is no delete, because an instructor carries bookings, classes and pay history. Two invariants are applied on the way through, so read the response rather than assuming the payload landed verbatim: deactivating always retires `bookability` to `Admin_only`, and `bookability` never outruns `visibility` - making someone `Private` pulls a `Public` bookability down with it. `contactId` is not editable: the profile is bound to one person, and re-pointing it would silently transfer their bookings and their pay. The staff-portal fields are refused here for the same reasons as on the create. parameters: - in: path name: id required: true schema: type: integer description: 1club instructor id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformInstructorUpdate' responses: '200': description: The updated instructor content: application/json: schema: $ref: '#/components/schemas/PlatformInstructorSummary' '400': $ref: '#/components/responses/PlatformBadRequest' '401': $ref: '#/components/responses/PlatformUnauthorized' '403': description: API key is missing the required `instructors:write` scope content: application/json: schema: $ref: '#/components/schemas/PlatformError' '404': $ref: '#/components/responses/PlatformNotFound' '429': $ref: '#/components/responses/PlatformRateLimited' security: - customerApiAuth: [] components: schemas: PlatformInstructorUpdate: type: object description: >- Fields accepted when updating an instructor. Send only what changes; an omitted field is left alone. At least one field is required, and unknown fields are rejected. `contactId` is absent on purpose: re-pointing a profile at another person would transfer their bookings and pay. minProperties: 1 properties: clubId: type: integer nullable: true description: >- Club the instructor works at; null means every club in the organization. instructorTypeId: type: integer nullable: true description: >- The kind of coach, from GET /v1/platform/instructor-types. null leaves them unfiled, which is legal but loses the grouping every roster view reads from and the default revenue account their sessions would post to. sports: type: array items: type: string maxItems: 50 displayName: type: string nullable: true maxLength: 120 description: >- Public-facing name. Defaults to " ." from the contact. hourlyRate: type: number nullable: true minimum: 0 description: >- What a **member pays** for an hour of one-to-one time with them. Not what the club pays the coach - that is a pay rate policy. Added to the area price unless `priceIncludesArea` is true. bookability: type: string enum: - Admin_only - Member_only - Public description: >- Who may book one-to-one sessions with them. Never outruns `visibility`: narrowing one pulls the other down with it, and deactivating the instructor retires this to `Admin_only`. The read-only `isBookable` is derived from this and cannot be written. priceIncludesArea: type: boolean description: >- When true, `hourlyRate` already covers the booked area, which is then not charged on top. maxConcurrentBookings: type: integer minimum: 1 operatingHours: type: object description: Per-day-of-week availability schedule additionalProperties: true visibility: type: string enum: - Private - Member_only - Public isActive: type: boolean description: >- False retires the instructor: they leave the listings and stop being bookable, and their history is kept. There is no delete. PlatformInstructorSummary: type: object description: >- An instructor (coach) in the organization, as returned by the instructors resource. Reference the `id` as `instructorId` when creating a booking. Leaner than the `PlatformInstructor` profile embedded in class payloads: this carries only what is needed to pick and price a coach. properties: id: type: integer name: type: string description: Public display name when set, otherwise the linked contact name. clubId: type: integer nullable: true description: Club the instructor belongs to; null when org-wide. instructorTypeId: type: integer nullable: true description: >- The kind of coach, from GET /v1/platform/instructor-types; null for one nobody has filed. sports: type: array items: type: string hourlyRate: type: number nullable: true description: >- Added to the area price when pricing a booking with this instructor, unless `priceIncludesArea` is true. priceIncludesArea: type: boolean description: >- When true, `hourlyRate` is an all-in price that already covers the booked area - the area's price is not added on top of it. bookability: type: string enum: - Admin_only - Member_only - Public description: >- Who may book one-to-one sessions with this instructor. `Admin_only` means the club reserves those bookings to its own staff, so a customer-initiated booking is rejected; an API key acts for the organization and may still create one. isBookable: type: boolean deprecated: true description: >- Derived from `bookability`: true unless it is `Admin_only`. Prefer `bookability`, which distinguishes members from the public. maxConcurrentBookings: type: integer operatingHours: type: object description: Per-day-of-week availability schedule visibility: type: string enum: - Private - Member_only - Public description: >- Who may see the instructor on member-facing surfaces. `bookability` never outruns it. isActive: type: boolean description: >- False for a retired instructor: hidden from the list by default, not bookable, history kept. 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. ````