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

# Replace location availability template

> Requires `location_availability:write`. Replaces the location availability template used to derive bookable slots. Unknown top-level fields are rejected; send only `weeklyPattern`, `overrides`, and `settings`.



## OpenAPI

````yaml /openapi/public-v1.json put /public/v1/locations/{locationId}/availability
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, payments, products, subscriptions, memberships, and credits
      with guarded finance writes.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read form metadata and submissions, and assign forms.
  - name: Documents
    description: Read document and folder metadata only.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Messaging
    description: Read client chat and message metadata.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
paths:
  /public/v1/locations/{locationId}/availability:
    put:
      tags:
        - Availability Management
      summary: Replace location availability template
      description: >-
        Requires `location_availability:write`. Replaces the location
        availability template used to derive bookable slots. Unknown top-level
        fields are rejected; send only `weeklyPattern`, `overrides`, and
        `settings`.
      operationId: putPublicV1LocationsByLocationIdAvailability
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
            example: booking-create-20260714-001
          description: >-
            Required for Public API write requests. Reusing the same key with
            the same method, path, and body replays the stored successful
            response; reusing it with a different request returns `409
            idempotency.conflict`.
        - name: locationId
          in: path
          required: true
          schema:
            type: string
            example: 66f7b8b1e13c8d25f4d3d90a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required: []
              properties:
                weeklyPattern:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - dayOfWeek
                      - isDayOff
                      - allowedEventTemplateIds
                      - slots
                    properties:
                      dayOfWeek:
                        type:
                          - integer
                          - 'null'
                      isDayOff:
                        type: boolean
                      allowedEventTemplateIds:
                        type: array
                        items:
                          type: string
                      slots:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          required:
                            - startTime
                            - endTime
                            - allowedEventTemplateIds
                          properties:
                            startTime:
                              type: string
                            endTime:
                              type: string
                            allowedEventTemplateIds:
                              type: array
                              items:
                                type: string
                overrides:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - date
                      - type
                      - reason
                      - allowedEventTemplateIds
                      - slots
                    properties:
                      date:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      type:
                        type: string
                        enum:
                          - DayOff
                          - CustomHours
                          - Maintenance
                      reason:
                        type: string
                      allowedEventTemplateIds:
                        type: array
                        items:
                          type: string
                      slots:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          required:
                            - startTime
                            - endTime
                            - allowedEventTemplateIds
                          properties:
                            startTime:
                              type: string
                            endTime:
                              type: string
                            allowedEventTemplateIds:
                              type: array
                              items:
                                type: string
                settings:
                  type: object
                  additionalProperties: false
                  required:
                    - maxBookingFutureDays
                    - minBookingNoticeMinutes
                    - bufferBetweenSessions
                    - blockCalendarCheck
                    - allowedEventTemplateIds
                  properties:
                    maxBookingFutureDays:
                      type: number
                    minBookingNoticeMinutes:
                      type: number
                    bufferBetweenSessions:
                      type: number
                    blockCalendarCheck:
                      type: boolean
                    allowedEventTemplateIds:
                      type: array
                      items:
                        type: string
            example:
              weeklyPattern:
                - dayOfWeek: 2
                  isDayOff: false
                  allowedEventTemplateIds: []
                  slots:
                    - startTime: '09:00'
                      endTime: '17:00'
                      allowedEventTemplateIds:
                        - 66f7b8b1e13c8d25f4d3d91b
              overrides: []
              settings:
                maxBookingFutureDays: 60
                minBookingNoticeMinutes: 60
                bufferBetweenSessions: 0
                blockCalendarCheck: true
                allowedEventTemplateIds: []
      responses:
        '200':
          description: Location availability updated
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiWriteSuccessResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        required:
                          - locationAvailability
                        properties:
                          locationAvailability:
                            $ref: '#/components/schemas/LocationAvailability'
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      locationAvailability:
                        locationId: 66f7b8b1e13c8d25f4d3d90a
                        weeklyPattern:
                          - dayOfWeek: 1
                            isDayOff: true
                            allowedEventTemplateIds:
                              - string
                            slots:
                              - startTime: string
                                endTime: string
                                allowedEventTemplateIds:
                                  - string
                        overrides:
                          - date: '2026-07-14T10:00:00.000Z'
                            type: DayOff
                            reason: string
                            allowedEventTemplateIds:
                              - string
                            slots:
                              - startTime: string
                                endTime: string
                                allowedEventTemplateIds:
                                  - string
                        settings:
                          maxBookingFutureDays: 1
                          minBookingNoticeMinutes: 1
                          bufferBetweenSessions: 1
                          blockCalendarCheck: true
                          allowedEventTemplateIds:
                            - string
                        createdAt: '2026-07-14T10:00:00.000Z'
                        updatedAt: '2026-07-14T10:00:00.000Z'
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                      idempotency:
                        replayed: false
        '201':
          description: Location availability created
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiWriteSuccessResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        required:
                          - locationAvailability
                        properties:
                          locationAvailability:
                            $ref: '#/components/schemas/LocationAvailability'
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      locationAvailability:
                        locationId: 66f7b8b1e13c8d25f4d3d90a
                        weeklyPattern:
                          - dayOfWeek: 1
                            isDayOff: true
                            allowedEventTemplateIds:
                              - string
                            slots:
                              - startTime: string
                                endTime: string
                                allowedEventTemplateIds:
                                  - string
                        overrides:
                          - date: '2026-07-14T10:00:00.000Z'
                            type: DayOff
                            reason: string
                            allowedEventTemplateIds:
                              - string
                            slots:
                              - startTime: string
                                endTime: string
                                allowedEventTemplateIds:
                                  - string
                        settings:
                          maxBookingFutureDays: 1
                          minBookingNoticeMinutes: 1
                          bufferBetweenSessions: 1
                          blockCalendarCheck: true
                          allowedEventTemplateIds:
                            - string
                        createdAt: '2026-07-14T10:00:00.000Z'
                        updatedAt: '2026-07-14T10:00:00.000Z'
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                      idempotency:
                        replayed: false
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyRequired:
                  summary: Missing Idempotency-Key
                  value:
                    error:
                      code: 400
                      key: idempotency.required
                      message: >-
                        Idempotency-Key header is required for Public API write
                        requests.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyInvalid:
                  summary: Invalid Idempotency-Key
                  value:
                    error:
                      code: 400
                      key: idempotency.invalid
                      message: Idempotency-Key header must be 200 characters or fewer.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          description: Auth missing/invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          description: Missing scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - location_availability:write
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          description: >-
            Conflict. The write request conflicts with idempotency or current
            resource state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                idempotencyConflict:
                  summary: Idempotency-Key conflict
                  value:
                    error:
                      code: 409
                      key: idempotency.conflict
                      message: >-
                        Idempotency-Key was already used with a different
                        request.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyInProgress:
                  summary: Idempotency-Key in progress
                  value:
                    error:
                      code: 409
                      key: idempotency.in_progress
                      message: >-
                        Idempotency-Key is already processing for this Public
                        API client.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '422':
          description: >-
            Unprocessable content. The request body is empty or is not a JSON
            object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                emptyBody:
                  summary: Empty or invalid JSON object body
                  value:
                    error:
                      code: 422
                      key: EMPTY_BODY
                      message: Request body must be a non-empty JSON object.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '429':
          description: >-
            Too many requests. The Public API client or caller IP exceeded the
            rate limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: >-
            Server error. The request could not be completed because of an
            unexpected Public API server failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PUT
            "https://api.fitsociety.io/public/v1/locations/<locationId>/availability"
            \
              -H "Authorization: Bearer <access_token>" \
              -H "Idempotency-Key: location-availability-20260721" \
              -H "Content-Type: application/json" \
              -d '{"weeklyPattern":[],"overrides":[]}'
components:
  schemas:
    PublicApiWriteSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiWriteMeta'
    LocationAvailability:
      type:
        - object
        - 'null'
      additionalProperties: false
      required:
        - locationId
        - weeklyPattern
        - overrides
        - settings
        - createdAt
        - updatedAt
      properties:
        locationId:
          type: string
        weeklyPattern:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - dayOfWeek
              - isDayOff
              - allowedEventTemplateIds
              - slots
            properties:
              dayOfWeek:
                type:
                  - integer
                  - 'null'
              isDayOff:
                type: boolean
              allowedEventTemplateIds:
                type: array
                items:
                  type: string
              slots:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - startTime
                    - endTime
                    - allowedEventTemplateIds
                  properties:
                    startTime:
                      type: string
                    endTime:
                      type: string
                    allowedEventTemplateIds:
                      type: array
                      items:
                        type: string
        overrides:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - date
              - type
              - reason
              - allowedEventTemplateIds
              - slots
            properties:
              date:
                type:
                  - string
                  - 'null'
                format: date-time
              type:
                type: string
                enum:
                  - DayOff
                  - CustomHours
                  - Maintenance
              reason:
                type: string
              allowedEventTemplateIds:
                type: array
                items:
                  type: string
              slots:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - startTime
                    - endTime
                    - allowedEventTemplateIds
                  properties:
                    startTime:
                      type: string
                    endTime:
                      type: string
                    allowedEventTemplateIds:
                      type: array
                      items:
                        type: string
        settings:
          type: object
          additionalProperties: false
          required:
            - maxBookingFutureDays
            - minBookingNoticeMinutes
            - bufferBetweenSessions
            - blockCalendarCheck
            - allowedEventTemplateIds
          properties:
            maxBookingFutureDays:
              type: number
            minBookingNoticeMinutes:
              type: number
            bufferBetweenSessions:
              type: number
            blockCalendarCheck:
              type: boolean
            allowedEventTemplateIds:
              type: array
              items:
                type: string
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicApiWriteMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
        idempotency:
          type: object
          additionalProperties: false
          properties:
            replayed:
              type: boolean
              description: >-
                True when the response was replayed from a previous request with
                the same `Idempotency-Key`.
              example: true
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`.

````