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"

clientIds
string[]
required

Client ids to assign the plan to. Duplicates are de-duplicated.

Minimum array length: 1
Example:
scheduleStartDate
string<date>

Sets week 1 of the programme. Required when the template uses multi_week or calendar_week; one date applies to every selected client, so every client gets the same treatment.

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 (anything else → 400 WORKOUTPLAN_SCHEDULE_INVALID); a sequence recurring template ignores the date.

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

"2026-09-07"

status
enum<string>

Defaults to Active when omitted.

Available options:
Active,
Inactive
Example:

"Active"

Response

Per-client assignment outcome. Partial success still returns 200.

data
object
required
meta
object
required