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

# Apply an audited weekly review

> Requires the cardio features and access to the target client. Applying a review requires expectedUpdatedAt from the preview and complete prescriptions. Historical logs, existing IDs, unrelated activities, and weekly volume limits are preserved. Goal time or challenge status can change; distance or race date requires a new plan. Undo requires the latest unchanged plan and no affected execution or past sessions; it cannot restore intensity during an active athlete niggle. Undo accepts an empty body.

Requires the `workout_client_plans:write` scope and the corresponding Workout features and permissions.

The clientId path parameter identifies a client in the company bound to the Public API token.



## OpenAPI

````yaml /openapi/public-v1.json post /public/v1/workout/cardio/clients/{clientId}/plans/{planId}/running-plan/review/apply
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Integrate with FITsociety through `/public/v1`. Use OAuth client credentials
    to obtain a Bearer access token, then call the endpoints available to the
    authenticated company and granted scopes.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Health
    description: Public API token health checks.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Platform
    description: Inspect Public API client context, capabilities, scopes, and 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, transactions, products, subscriptions, and memberships, and
      manage finance actions.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations and mutations, and
      adjust credits.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - 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, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
  - name: Workout
    description: >-
      Workout libraries, programmes, client plans, calendars, sessions, groups,
      settings and progress. AI operations are excluded.
paths:
  /public/v1/workout/cardio/clients/{clientId}/plans/{planId}/running-plan/review/apply:
    post:
      tags:
        - Workout
      summary: Apply an audited weekly review
      description: >-
        Requires the cardio features and access to the target client. Applying a
        review requires expectedUpdatedAt from the preview and complete
        prescriptions. Historical logs, existing IDs, unrelated activities, and
        weekly volume limits are preserved. Goal time or challenge status can
        change; distance or race date requires a new plan. Undo requires the
        latest unchanged plan and no affected execution or past sessions; it
        cannot restore intensity during an active athlete niggle. Undo accepts
        an empty body.


        Requires the `workout_client_plans:write` scope and the corresponding
        Workout features and permissions.


        The clientId path parameter identifies a client in the company bound to
        the Public API token.
      operationId: >-
        publicWorkoutpostPublicV1WorkoutCardioClientsClientIdPlansPlanIdRunningPlanReviewApply
      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: clientId
          in: path
          required: true
          schema:
            type: string
        - name: planId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PublicWorkoutSourcePOSTAppV1WorkoutCardioClientsClientIdPlansPlanIdRunningPlanReviewApplyRequest
      responses:
        '200':
          description: Review result. Preview diagnostics are returned without writing.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiWriteSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourcePOSTAppV1WorkoutCardioClientsClientIdPlansPlanIdRunningPlanReviewApplyResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      decision:
                        _id: 66f7b8b1e13c8d25f4d3d90a
                        planId: 66f7b8b1e13c8d25f4d3d90a
                        kind: weekly_review
                        status: review_required
                        reviewWeek: 1
                        reasonCodes:
                          - string
                        evidence:
                          source: string
                          throughDate: '2026-07-14'
                          qualifyingRunCount: 1
                          missedRunCount: 1
                          latestRunDate: '2026-07-14'
                          reportedAt: '2026-07-14T10:00:00.000Z'
                        affectedItemIds:
                          - string
                        createdAt: '2026-07-14T10:00:00.000Z'
                        appliedAt: '2026-07-14T10:00:00.000Z'
                        appliedBy: string
                        undoneAt: '2026-07-14T10:00:00.000Z'
                        undoneBy: string
                      expectedUpdatedAt: '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: Invalid IDs or missing body.
          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':
          $ref: '#/components/schemas/ErrorResponse'
          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: >-
            Wrong actor, disabled gate, client not linked, or insufficient
            member scope/permission.
          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:
                          - workout_client_plans:write
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: Scoped assigned plan or decision 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':
          $ref: '#/components/schemas/ErrorResponse'
          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: >-
            Invalid, unresolved, not-due, out-of-order, stale or unsafe
            review/undo. No partial writes.
          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':
          $ref: '#/components/schemas/ErrorResponse'
          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: Unexpected server error.
          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: cURL
          label: cURL
          source: >-
            curl -X POST
            "https://api.fitsociety.io/public/v1/workout/cardio/clients/{clientId}/plans/{planId}/running-plan/review/apply"
            \
              -H "Authorization: Bearer <access_token>" \
              -H "Idempotency-Key: <stable_request_key>" \
              -H "Content-Type: application/json" \
              -d '{}'
components:
  schemas:
    PublicWorkoutSourcePOSTAppV1WorkoutCardioClientsClientIdPlansPlanIdRunningPlanReviewApplyRequest:
      $ref: '#/components/schemas/PublicWorkoutSourceRunningReviewInput'
    PublicApiWriteSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiWriteMeta'
    PublicWorkoutSourcePOSTAppV1WorkoutCardioClientsClientIdPlansPlanIdRunningPlanReviewApplyResponse200:
      type: object
      properties:
        decision:
          type: object
          properties:
            _id:
              type: string
            planId:
              type: string
            kind:
              type: string
              enum:
                - weekly_review
                - niggle_suppression
            status:
              type: string
              enum:
                - review_required
                - applied
                - undone
                - superseded
            reviewWeek:
              type: integer
            reasonCodes:
              type: array
              items:
                type: string
              description: Server evidence/diagnostic codes; no fitness-change claim.
            evidence:
              type: object
              properties:
                source:
                  type: string
                throughDate:
                  type:
                    - string
                    - 'null'
                  format: date
                qualifyingRunCount:
                  type: integer
                  minimum: 0
                missedRunCount:
                  type: integer
                  minimum: 0
                latestRunDate:
                  type:
                    - string
                    - 'null'
                  format: date
                reportedAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
              additionalProperties: false
            affectedItemIds:
              type: array
              items:
                type: string
            createdAt:
              type: string
              format: date-time
            appliedAt:
              type: string
              format: date-time
            appliedBy:
              type: string
            undoneAt:
              type: string
              format: date-time
            undoneBy:
              type: string
        expectedUpdatedAt:
          type: string
          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'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicWorkoutSourceRunningReviewInput:
      type: object
      additionalProperties: false
      required:
        - reviewWeek
        - intake
      properties:
        reviewWeek:
          type: integer
          minimum: 1
          maximum: 104
          description: >-
            Next unreviewed week; due when all running sessions finish/cancel or
            the athlete-local week ends.
        expectedUpdatedAt:
          type: string
          format: date-time
          description: >-
            Required for apply. Use the timestamp returned by review preview;
            stale plans return 422.
        intake:
          type: object
          additionalProperties: false
          required:
            - persistentRunningPain
            - bonePointTenderness
            - nightPain
            - worseningDespiteRest
          properties:
            persistentRunningPain:
              type: boolean
            bonePointTenderness:
              type: boolean
            nightPain:
              type: boolean
            worseningDespiteRest:
              type: boolean
        prescriptions:
          type: array
          maxItems: 3
          items:
            $ref: '#/components/schemas/PublicWorkoutSourceRunningPlanWeekInput'
          description: >-
            Explicit inputs for the returned future horizon. Week numbers are
            absolute plan weeks. No automatic warm-up, recovery, allocation or
            long-run increments.
        goal:
          $ref: '#/components/schemas/PublicWorkoutSourceRunningPlanGoal'
    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'
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicWorkoutSourceRunningPlanWeekInput:
      type: object
      additionalProperties: false
      required:
        - weekNumber
        - sessions
      properties:
        weekNumber:
          type: integer
          minimum: 1
          maximum: 3
        sessions:
          type: array
          maxItems: 7
          items:
            $ref: '#/components/schemas/PublicWorkoutSourceRunningPlanSessionInput'
    PublicWorkoutSourceRunningPlanGoal:
      type: object
      additionalProperties: false
      required:
        - distance
        - goalTimeSec
        - raceDate
      properties:
        distance:
          type: string
          enum:
            - 5K
            - 10K
            - half
            - marathon
        goalTimeSec:
          type: number
          exclusiveMinimum: 0
          description: >-
            Finish time in seconds. Localized numeric strings are accepted on
            input.
        raceDate:
          type: string
          format: date
          description: Canonical YYYY-MM-DD athlete calendar date.
        acceptGoalAsChallenge:
          type: boolean
          default: false
    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
    PublicWorkoutSourceRunningPlanSessionInput:
      type: object
      additionalProperties: false
      required:
        - weekday
      properties:
        weekday:
          type: integer
          minimum: 1
          maximum: 7
        easyKm:
          type: number
          exclusiveMinimum: 0
          description: Explicit easy-run distance. Mutually exclusive with easyWeight.
        easyWeight:
          type: number
          exclusiveMinimum: 0
          description: >-
            Coach-selected relative share of the remaining week budget after
            other prescribed sessions. All weights are normalized; no
            distribution default is invented.
        warmupMinutes:
          type: number
          exclusiveMinimum: 0
        cooldownMinutes:
          type: number
          exclusiveMinimum: 0
        thresholdRecoverySec:
          type: number
          minimum: 60
          maximum: 120
        racePaceKm:
          type: number
          exclusiveMinimum: 0
        longRunMinutes:
          type: number
          exclusiveMinimum: 0
          description: >-
            Required coach-selected progression for half/marathon, bounded by
            the phase target. 5K/10K use the source phase duration.
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.