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"

Path Parameters

clientId
string
required
planId
string
required

Body

application/json
goal
object
required
startDate
string<date>
required
runWeekdays
integer[]
required

Monday=1, Sunday=7. Must respect stored availability, fixed days and run-day count.

Minimum array length: 3
Required range: 1 <= x <= 7
qualityWeekdays
integer[]
required

Two selected running days, ordered by weekday; distinct from the long run.

Required array length: 2 elements
Required range: 1 <= x <= 7
longRunWeekday
integer
required
Required range: 1 <= x <= 7
concreteWeeks
enum<integer>
required
Available options:
2,
3
intake
object
required
prescriptions
object[]

Explicit coach inputs for the concrete horizon. Missing values are preview diagnostics and block saving. Later weeks stay skeletons.

Maximum array length: 3

Response

Successful result.

data
object
required
meta
object
required