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
templatePlanIds
string[]
required
Minimum array length: 1
Example:
clientIds
string[]
required
Minimum array length: 1
Example:
scheduleStartDate
string<date>

Sets week 1 of the programme. Required when any selected template uses multi_week or calendar_week. The SAME date applies to every selected plan/client pair, and each template interprets it by its own mode.

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, and week 1's lead-in work is DROPPED rather than deferred.

Recurring templates are unchanged. A calendar_week recurring template still requires a canonical company-local Monday; a sequence recurring template ignores the date. In a MIXED batch this is validated up front for every resolved template, so a mid-week date sent alongside a recurring calendar template fails the WHOLE request with 400 WORKOUTPLAN_SCHEDULE_INVALID and nothing is assigned.

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

"2026-09-07"

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

"Active"

Response

Per-template and per-client assignment outcome.

data
object
required
meta
object
required