URL where players download or launch the build. Pass null to clear it.
--onboardingIdentityProviders
value
The identities a player must hold before playing, in canonical order. Pass null to reset to the default (email).
--ndaManagementEnabled
flag
Whether the NDA is active for this playtest.
--buildDistributionEnabled
flag
Whether the Build Distribution component is active for this playtest.
--keyDistributionEnabled
flag
Whether Key Distribution is active for this playtest.
--playtestBriefingEnabled
flag
Whether Session Briefing is active for this playtest (master flag).
--playtestObjectivesEnabled
flag
Whether Session Objectives is active for this playtest (master flag).
--playtestSurveyEnabled
flag
Whether Survey is active for this playtest (master flag).
--recordingEnabled
flag
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
flag
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.
--playtestCaptureAudio
value
Whether microphone capture is off, optional, or required.
--playtestCaptureScreen
value
Whether screen capture is off, optional, or required.
New number of play sessions for a multi-session playtest, from 2 to 6. (required)
--body
value
Full JSON request body (merged with flags).
--body-file
value
Path to a JSON body file.
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Userplay","description":"Playtesting infrastructure for game studios. Run playtests, recruit and screen players, distribute builds and keys, record gameplay, and turn sessions into insight.","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/userplay/5Uj_hAT2wEWV4yog/static/logo-light.svg?fit=max\u0026auto=format\u0026n=5Uj_hAT2wEWV4yog\u0026q=85\u0026s=16613355113b8b1074fc4924d5cbad0e","dark":"https://mintcdn.com/userplay/5Uj_hAT2wEWV4yog/static/logo-dark.svg?fit=max\u0026auto=format\u0026n=5Uj_hAT2wEWV4yog\u0026q=85\u0026s=890719bb8573e00c3cf420705b1881dd"},"favicon":"https://mintcdn.com/userplay/5Uj_hAT2wEWV4yog/static/favicon.svg?fit=max\u0026auto=format\u0026n=5Uj_hAT2wEWV4yog\u0026q=85\u0026s=2f52b1d6c26ba013909ed13583d691a4","api":{"playground":{"display":"interactive"}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open Studio","href":"https://studio.userplay.io"}},"footer":{"socials":{"website":"https://userplay.io"},"links":[{"header":"Product","items":[{"label":"Studio","href":"https://studio.userplay.io"},{"label":"Pricing","href":"https://userplay.io/pricing"},{"label":"Player portal","href":"https://player.userplay.io"}]},{"header":"Resources","items":[{"label":"Quickstart","href":"https://docs.userplay.io/quickstart"},{"label":"Developers","href":"https://docs.userplay.io/developers/overview"},{"label":"API reference","href":"https://docs.userplay.io/api-reference"}]}]},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userplay","hasAudioNarration":false,"actualSubdomain":"userplay","customDomains":["docs.userplay.io"],"gitSource":{"type":"github","owner":"userplaylabs","repo":"userplay","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae95a75b4f7670642c7dec9:success","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Playbooks","count":168},{"language":"default","tag":"Guide","count":141},{"language":"default","tag":"API Reference","count":103},{"language":"default","tag":"Playtests","count":43},{"language":"default","tag":"NDAs","count":25},{"language":"default","tag":"Waitlists","count":25},{"language":"default","tag":"Surveys","count":24},{"language":"default","tag":"CLI Reference","count":18},{"language":"default","tag":"Commands","count":17},{"language":"default","tag":"Key vaults","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"cli-reference/playtests","slug":"/cli-reference/playtests","pageMetadata":{"title":"Playtests","description":"Playtests and their player rosters.","href":"/cli-reference/playtests"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Playtests and their player rosters.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`userplay-playtests-add-keys-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests add-keys \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Add keys to a playtest’s key vault`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--keyType`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`(required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--steamKeyType`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Steam key variant (playtest_standard, default_release, release_state_override, developer_autogrant). Only when keyType is ‘steam’.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--steamRedeemScope`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`What a Steam key unlocks (game, dlc, bundle). Only when keyType is ‘steam’.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--keys`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`(required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-add-players-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests add-players \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Add players to a playtest`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--emails`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Email addresses to add to the playtest roster. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-create-\u003cstudioid>`,children:_jsx(_components.code,{children:`userplay playtests create \u003cstudioId>`})}),`\n`,_jsx(_components.p,{children:`Create a playtest (draft)`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]})})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestType`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`The kind of playtest to run. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestName`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Display name of the playtest. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestDescription`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Optional description shown to your team.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--buildDistributionUrl`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`URL where players download or launch the build.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestSessionCount`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Number of play sessions to collect, from 1 to 6. Single-session playtests use 1. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--minSessionDuration`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Minimum length of a valid session, in seconds. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--sessionCooldown`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Minimum gap between a player’s sessions, in seconds (up to 3600).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--emails`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Email addresses to add to the playtest roster.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--maxPlayers`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Total-player cap for a shareable self-join link. Omit for a roster-only playtest.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-duplicate-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests duplicate \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Duplicate a playtest as a new draft`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestName`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`(required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--copyRoster`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-get-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests get \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Get a playtest`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-import-keys-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests import-keys \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Import keys into a playtest’s key vault`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--keyType`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`(required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--steamKeyType`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Steam key variant (playtest_standard, default_release, release_state_override, developer_autogrant). Only when keyType is ‘steam’.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--steamRedeemScope`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`What a Steam key unlocks (game, dlc, bundle). Only when keyType is ‘steam’.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--sourceKeyVaultIds`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`(required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--scope`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--maxCount`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-import-players-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests import-players \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Import players from groups`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playerGroupIds`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`IDs of player groups whose members are added to the playtest. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-key-vault-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests key-vault \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Get a playtest’s key vault`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-list-\u003cstudioid>`,children:_jsx(_components.code,{children:`userplay playtests list \u003cstudioId>`})}),`\n`,_jsx(_components.p,{children:`List playtests`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]})})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--page`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Page number to fetch, 1-based. Defaults to 1.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--perPage`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Items per page, 1 to 50. Defaults to 20.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--sortOrder`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Sort by creation time: asc (oldest first) or desc (newest first). Defaults to desc.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--query`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Search playtests by name.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-list-players-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests list-players \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`List a playtest’s players`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--page`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Page number to fetch, 1-based. Defaults to 1.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--perPage`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Items per page, 1 to 50. Defaults to 20.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--sortOrder`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Sort by creation time: asc (oldest first) or desc (newest first). Defaults to desc.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-replace-players-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests replace-players \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Replace a playtest’s roster`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--emails`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Email addresses that become the playtest’s complete roster, replacing the current players. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-set-access-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests set-access \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Set a playtest’s access mode`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--mode`})}),_jsx(_components.td,{children:`value`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`open`}),` for the public self-join link, `,_jsx(_components.code,{children:`closed`}),` for an email-restricted roster. (required)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-set-share-link-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests set-share-link \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Set an open playtest’s player cap`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--maxPlayers`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Total-player cap for the share link. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-share-url-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests share-url \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Get an open playtest’s share link`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-update-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests update \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Update a playtest’s setup`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestName`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`New display name for the playtest.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestDescription`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Team-facing description. Pass null to clear it.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--buildDistributionUrl`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`URL where players download or launch the build. Pass null to clear it.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--onboardingIdentityProviders`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`The identities a player must hold before playing, in canonical order. Pass null to reset to the default (email).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--ndaManagementEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether the NDA is active for this playtest.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--buildDistributionEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether the Build Distribution component is active for this playtest.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--keyDistributionEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether Key Distribution is active for this playtest.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestBriefingEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether Session Briefing is active for this playtest (master flag).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestObjectivesEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether Session Objectives is active for this playtest (master flag).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestSurveyEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`Whether Survey is active for this playtest (master flag).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--recordingEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`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.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--screeningEnabled`})}),_jsx(_components.td,{children:`flag`}),_jsx(_components.td,{children:`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.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestCaptureAudio`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Whether microphone capture is off, optional, or required.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestCaptureScreen`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Whether screen capture is off, optional, or required.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestCaptureEvents`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`How gameplay events are captured.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-update-highlights-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests update-highlights \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Update a playtest’s highlights config`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-update-screening-eligibility-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests update-screening-eligibility \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Update a playtest’s screening eligibility`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-playtests-update-session-count-\u003cstudioid>-\u003cplaytestid>`,children:_jsx(_components.code,{children:`userplay playtests update-session-count \u003cstudioId> \u003cplaytestId>`})}),`\n`,_jsx(_components.p,{children:`Update a playtest’s session count`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Argument`}),_jsx(_components.th,{children:`Required`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`studioId`})}),_jsx(_components.td,{children:`yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`playtestId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playtestSessionCount`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`New number of play sessions for a multi-session playtest, from 2 to 6. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Full JSON request body (merged with flags).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--body-file`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Path to a JSON body file.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Playtests","description":"Playtests and their player rosters.","href":"/cli-reference/playtests"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"userplay playtests add-keys \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-add-keys-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests add-players \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-add-players-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests create \u003cstudioId>","slug":"userplay-playtests-create-\u003cstudioid>","depth":3,"children":[]},{"title":"userplay playtests duplicate \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-duplicate-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests get \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-get-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests import-keys \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-import-keys-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests import-players \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-import-players-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests key-vault \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-key-vault-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests list \u003cstudioId>","slug":"userplay-playtests-list-\u003cstudioid>","depth":3,"children":[]},{"title":"userplay playtests list-players \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-list-players-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests replace-players \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-replace-players-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests set-access \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-set-access-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests set-share-link \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-set-share-link-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests share-url \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-share-url-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests update \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-update-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests update-highlights \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-update-highlights-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests update-screening-eligibility \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-update-screening-eligibility-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]},{"title":"userplay playtests update-session-count \u003cstudioId> \u003cplaytestId>","slug":"userplay-playtests-update-session-count-\u003cstudioid>-\u003cplaytestid>","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"userplay","siteName":"Userplay","title":"Playtests - Userplay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-26T06:48:40.930Z","originalFileLocation":"cli-reference/playtests.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Playtests and their player rosters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userplay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Playtests - Userplay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Playtests and their player rosters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userplay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userplay.io/cli-reference/playtests\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://userplay.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=Playtests\u0026amp;description=Playtests+and+their+player+rosters.\u0026amp;theme=8b51140b7ac8cec2b7b34f9b\u0026amp;signature=ca35321f478d03e75de74f348aaf875152d5dc29a8651c211d2a418b20085137\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Playtests - Userplay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Playtests and their player rosters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://userplay.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=Playtests\u0026amp;description=Playtests+and+their+player+rosters.\u0026amp;theme=8b51140b7ac8cec2b7b34f9b\u0026amp;signature=ca35321f478d03e75de74f348aaf875152d5dc29a8651c211d2a418b20085137\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/userplay/iXMu-iG4pYIy1Jk3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userplay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userplay.io/cli-reference/playtests\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli-reference/playtests.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userplay.io/#organization\",\"name\":\"Userplay\",\"url\":\"https://docs.userplay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/userplay/5Uj_hAT2wEWV4yog/static/logo-light.svg?fit=max\u0026auto=format\u0026n=5Uj_hAT2wEWV4yog\u0026q=85\u0026s=16613355113b8b1074fc4924d5cbad0e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userplay.io#website\",\"name\":\"Userplay\",\"url\":\"https://docs.userplay.io\",\"publisher\":{\"@id\":\"https://docs.userplay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userplay.io/cli-reference/playtests#webpage\",\"url\":\"https://docs.userplay.io/cli-reference/playtests\",\"name\":\"Playtests\",\"description\":\"Playtests and their player rosters.\",\"dateModified\":\"2026-07-26T06:48:40.930Z\",\"isPartOf\":{\"@id\":\"https://docs.userplay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userplay.io/cli-reference/playtests#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userplay.io/cli-reference/playtests#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commands\",\"item\":\"https://docs.userplay.io/cli-reference/config\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Playtests\",\"item\":\"https://docs.userplay.io/cli-reference/playtests\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.userplay.io/cli-reference/playtests#article\",\"headline\":\"Playtests\",\"name\":\"Playtests\",\"description\":\"Playtests and their player rosters.\",\"url\":\"https://docs.userplay.io/cli-reference/playtests\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userplay.io/cli-reference/playtests#webpage\"},\"dateModified\":\"2026-07-26T06:48:40.930Z\",\"publisher\":{\"@id\":\"https://docs.userplay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userplay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userplay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Userplay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/cli-reference/playtests.md","siteName":"Userplay","nav":{"global":null,"tabs":[{"tab":"Guide","pages":[{"title":"Guide","href":"/introduction"}]},{"tab":"Playbooks","pages":[{"title":"Playbooks","href":"/playbooks/overview"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/account/get-your-account"}]},{"tab":"CLI Reference","groups":[{"group":"Overview","icon":"terminal","pages":[{"title":"Command reference","href":"/cli-reference/overview"}]},{"group":"Commands","icon":"book","pages":[{"title":"Authentication \u0026 config","href":"/cli-reference/config"},{"title":"Studios","description":"The studios you belong to.","href":"/cli-reference/studios"},{"title":"Playtests","href":"/cli-reference/playtests"},{"title":"Surveys","description":"Surveys, their screening forms, members, and results.","href":"/cli-reference/surveys"},{"title":"Waitlists","href":"/cli-reference/waitlists"},{"title":"NDAs","href":"/cli-reference/ndas"},{"title":"Players","href":"/cli-reference/players"},{"title":"Player groups","href":"/cli-reference/player-groups"},{"title":"Key vaults","href":"/cli-reference/key-vaults"},{"title":"Members","href":"/cli-reference/members"},{"title":"Sessions","href":"/cli-reference/sessions"},{"title":"Submissions","href":"/cli-reference/submissions"},{"title":"Highlights","href":"/cli-reference/highlights"},{"title":"Results","href":"/cli-reference/results"},{"title":"Exports","href":"/cli-reference/exports"},{"title":"Feedback","href":"/cli-reference/feedback"},{"title":"Account","href":"/cli-reference/account"}]}]}]},"basePath":"","title":"Playtests - Userplay","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}