Skip to main content
PATCH
Update a playtest's setup

Authorizations

Authorization
string
header
required

Personal API key (prefix up_). Create one in the studio under Account → API keys.

Path Parameters

studioId
string
required
playtestId
string
required

Body

application/json
playtestName
string

New display name for the playtest.

Required string length: 2 - 80
playtestDescription
string | null

Team-facing description. Pass null to clear it.

Maximum string length: 2000
buildDistributionUrl
string<uri> | null

URL where players download or launch the build. Pass null to clear it.

Maximum string length: 2048
onboardingContent
object[] | null

Onboarding content shown before the identity step. Empty content skips straight to the Identities step.

Maximum array length: 20
onboardingIdentityProviders
enum<string>[] | null

The identities a player must hold before playing, in canonical order. Pass null to reset to the default (email).

Minimum array length: 1
Available options:
email,
discord,
steam,
google
ndaBriefingContent
object[] | null

The NDA shown to players before their first session. Pass null to clear it.

Maximum array length: 20
ndaManagementEnabled
boolean

Whether the NDA is active for this playtest.

ndaCustomAgreements
object[] | null

Extra agreement checkboxes shown on the NDA, each ticked before acknowledging. Labels support basic markup (bold, italic, links [blocked]). Pass null to clear them.

Maximum array length: 5
buildDistributionContent
object[] | null

Build distribution instructions shown to players. Pass null to clear it.

Maximum array length: 20
buildDistributionEnabled
boolean

Whether the Build Distribution component is active for this playtest.

keyDistributionEnabled
boolean

Whether Key Distribution is active for this playtest.

playtestBriefingEnabled
boolean

Whether Session Briefing is active for this playtest (master flag).

playtestObjectivesEnabled
boolean

Whether Session Objectives is active for this playtest (master flag).

playtestSurveyEnabled
boolean

Whether Survey is active for this playtest (master flag).

recordingEnabled
boolean

Whether Gameplay Recording is active for this playtest. When off, players skip recording and no gameplay recording credits are consumed at publish. Editable only in draft/unpublished.

screeningEnabled
boolean

Whether Screening is active for this playtest (master flag). When off, players skip the screening step and join directly, and the eligibility rule is not evaluated. Cannot be enabled without screening content. Editable only in draft/unpublished.

playtestScreening
object[] | null

Screening shown first to open-playtest players: content plus optional questions used to gate eligibility. Pass null to clear it.

Maximum array length: 20
playtestCaptureAudio
enum<string>

Whether microphone capture is off, optional, or required.

Available options:
enabled,
optional
playtestCaptureScreen
enum<string>

Whether screen capture is off, optional, or required.

Available options:
enabled,
optional
playtestCaptureEvents
enum<string>

How gameplay events are captured.

Available options:
enabled,
disabled

Response

200 - application/json

The updated playtest

data
object
required