Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

price_variant_id
string
required

The price variant ID

Body

application/json
experience_id
string
required

Experience ID or slug to link

Response

Experience linked

id
string
required
object
string
required
name
string
required
slug
string
required
description
string | null
required
access_type
enum<string>
required
Available options:
secret,
open
created_at
string<date-time>
required
updated_at
string<date-time>
required
type
string
required
active_grants_count
integer
required
details
object
required

Type-specific fields, shaped by the experience's type. Mirrors what PATCH accepts under details (see the per-type *DetailsRequest schemas), plus read-only collections (e.g. a course's chapters).