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
conversationType
enum<string>
required
Available options:
direct,
group
Example:

"group"

participants
object[]
required
Required array length: 2 - 100 elements
name
string

Required for group conversations.

Example:

"Nutrition follow-up"

description
string
Example:

"Coach team and member chat."

createdBy
object

Optional coach creator. Defaults to the requesting coach when available and must match it when provided.

context
object
isClientReplyAllowed
boolean

Group setting; defaults to true.

Example:

true

Response

Conversation created

data
object
required
meta
object
required