Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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.

Headers

Idempotency-Key
string
required

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.

Required string length: 1 - 200
Example:

"booking-create-20260714-001"

Body

application/json
templatePlanId
string
required
Example:

"67f1234567890abcdef1234"

clientId
string
required
Example:

"67f1234567890abcdef1234"

hideUntilStartDate
boolean
default:false

Keep each assigned copy hidden and unavailable to the client until midnight on scheduleStartDate in the company timezone. Requires a valid scheduleStartDate, including for ordinary recurring plans. Stored release time is UTC; a calendar programme's Monday anchor does not move this release date. Coaches retain access. Inactive remains Inactive. Future assignments do not send an immediate assignment notification. Existing assignments are unchanged.

scheduleStartDate
string<date>

Sets week 1 of the programme. Required for coach assignments when the template uses multi_week or calendar_week.

A multi_week + calendar_week template accepts ANY weekday. A mid-week date is absorbed into week 1: the stored schedule.startDate snaps back to that week's Monday, and week 1's days BEFORE the chosen weekday become rest days. Weeks 2..n land exactly where authored. Week 1's lead-in work is therefore DROPPED, not deferred — a Friday start on a Mon/Wed/Fri plan gives that client one session in week 1 instead of three, and a Sunday start rests week 1 almost entirely.

Recurring templates are unchanged. A calendar_week recurring template still requires a canonical company-local Monday (anything else → 400 WORKOUTPLAN_SCHEDULE_INVALID), because it repeats week 1 forever and resting out its lead-in would drop that work from every future cycle. A sequence recurring template ignores the date entirely.

Clients that self-assign may omit it and use the company-local current date or Monday.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-07"

status
enum<string>
Available options:
Active,
Inactive
Example:

"Active"

Response

Assigned-plan identifiers.

data
object
required
meta
object
required