Skip to main content
PATCH
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

runId
string
required

Group workout run id.

Example:

"67f1234567890abcdef1234"

clientId
string
required

Participant client id.

Example:

"67f1234567890abcdef1234"

Body

application/json
action
enum<string>
required
Available options:
pause,
resume,
complete,
stop,
cancel
notes
string

Optional completion note. The coach UI may omit this field.

Response

Participant status updated.

data
object
required
meta
object
required