> ## 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. # Set a superset's rest (client's own) > Sets (or clears) the CLIENT's own rest for one superset in this session — the single "Rest time" a group gets, since a superset is executed as a round and rests once after its last member rather than per set. Stored against the group's `groupId` on the session. The session-side twin of PATCH …/plans/template/{planId}/moments/{planMomentId}/supersets/{groupId}/rest (the coach's prescription). The two are INDEPENDENT and are surfaced separately by the read screens — this one drives `supersetRest`, the plan one `supersetRestPlan` — so neither overwrites the other. Addresses each superset DIRECTLY by its groupId, so several groups in one session can be set in any order and at any time — unlike `supersetRest` on PUT …/exercises/{exerciseId}, which can only reach a group through a member that has already been logged. Works for plan-day, freestyle and WOD sessions. Requires the workout_sessions:write scope. This operation maps to /app/v1/workout/performance/sessions/:sessionId/supersets/:groupId/rest and retains its Workout V2 permission, feature-flag, and resource-scope checks. The clientId path parameter is resolved inside the company bound to the Public API token when present. ## OpenAPI ````yaml /openapi/public-v1.json patch /public/v1/workout/performance/sessions/{sessionId}/supersets/{groupId}/rest 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: Workout description: >- Workout V2 libraries, programmes, client plans, calendars, sessions, groups, settings and progress. AI operations are excluded. - 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, transactions, products, subscriptions, and memberships with guarded finance writes. - name: Credits description: >- Read company-wide and client-scoped credit allocations, mutations, and guarded credit adjustments. - 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. paths: /public/v1/workout/performance/sessions/{sessionId}/supersets/{groupId}/rest: patch: tags: - Workout summary: Set a superset's rest (client's own) description: >- Sets (or clears) the CLIENT's own rest for one superset in this session — the single "Rest time" a group gets, since a superset is executed as a round and rests once after its last member rather than per set. Stored against the group's `groupId` on the session. The session-side twin of PATCH …/plans/template/{planId}/moments/{planMomentId}/supersets/{groupId}/rest (the coach's prescription). The two are INDEPENDENT and are surfaced separately by the read screens — this one drives `supersetRest`, the plan one `supersetRestPlan` — so neither overwrites the other. Addresses each superset DIRECTLY by its groupId, so several groups in one session can be set in any order and at any time — unlike `supersetRest` on PUT …/exercises/{exerciseId}, which can only reach a group through a member that has already been logged. Works for plan-day, freestyle and WOD sessions. Requires the workout_sessions:write scope. This operation maps to /app/v1/workout/performance/sessions/:sessionId/supersets/:groupId/rest and retains its Workout V2 permission, feature-flag, and resource-scope checks. The clientId path parameter is resolved inside the company bound to the Public API token when present. operationId: >- publicWorkoutpatchPublicV1WorkoutPerformanceSessionsSessionIdSupersetsGroupIdRest 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`. - in: path name: sessionId required: true description: Workout session id. schema: type: string example: 67f1234567890abcdef1234 - in: path name: groupId required: true description: Superset group id. schema: type: string example: 67f1234567890abcdef1234 - in: query name: clientId required: false schema: type: string example: 67f1234567890abcdef1234 description: Target client id (coaches/admins only). requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdSupersetsGroupIdRestRequest responses: '200': description: Superset rest updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/PublicApiWriteSuccessResponse' - type: object properties: data: $ref: >- #/components/schemas/PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdSupersetsGroupIdRestResponse200 examples: success: summary: Successful response value: data: sessionId: 67f1234567890abcdef1234 groupId: 6a2b1c3d4e5f60718293a4b5 supersetRest: 90 exerciseCount: 2 exercises: - performanceId: 67f1234567890abcdef1234 exerciseId: 67f1234567890abcdef1234 order: 0 meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 idempotency: replayed: false '400': description: >- Validation error. Keys: `INVALID_SESSION_ID`, `INVALID_ID`, `SUPERSET_REST_REQUIRED` (the `supersetRest` key was absent), `SUPERSET_REST_INVALID` (not a non-negative number), `SESSION_CONFIRMATION_PENDING` (a resume/restart handshake must be settled first). 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: Caller is not authorized for this client. 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: - required:scope meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '404': description: >- Session (`SESSION_NOT_FOUND`) or superset (`SUPERSET_NOT_FOUND` — fewer than 2 members, so it is not a superset) 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': $ref: '#/components/schemas/ErrorResponse' 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 PATCH "https://api.fitsociety.io/public/v1/workout/performance/sessions/{sessionId}/supersets/{groupId}/rest" \ -H "Authorization: Bearer " \ -H "Idempotency-Key: " \ -H "Content-Type: application/json" \ -d '{}' components: schemas: PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdSupersetsGroupIdRestRequest: type: object required: - supersetRest properties: supersetRest: oneOf: - type: integer minimum: 0 example: 90 - type: 'null' description: >- Rest for the whole superset, in seconds. `null` (or `""`) clears it; `0` is a real value meaning no rest. The key must be PRESENT — an empty body is rejected so a stray request cannot blank the value. clientId: type: string example: 67f1234567890abcdef1234 PublicApiWriteSuccessResponse: type: object additionalProperties: false required: - data - meta properties: data: type: object meta: $ref: '#/components/schemas/PublicApiWriteMeta' PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdSupersetsGroupIdRestResponse200: type: object properties: sessionId: type: string example: 67f1234567890abcdef1234 groupId: type: string example: 6a2b1c3d4e5f60718293a4b5 supersetRest: oneOf: - type: integer example: 90 - type: 'null' description: >- The client's own rest now in effect for the whole group, read back from the saved session (null when none). exerciseCount: type: integer example: 2 exercises: type: array description: The superset's members, in order. items: type: object properties: performanceId: type: string example: 67f1234567890abcdef1234 exerciseId: type: string example: 67f1234567890abcdef1234 order: type: integer example: 0 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 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 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_...`. 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.