New description for the group. Pass null to clear it.
--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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"cli-reference/player-groups","slug":"/cli-reference/player-groups","pageMetadata":{"title":"Player groups","description":"Reusable groups of players.","href":"/cli-reference/player-groups"},"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: \"Reusable groups of players.\"\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-player-groups-add-members-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups add-members \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`Add members to a group`}),`\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:`groupId`})}),_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,{})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playerIds`})}),_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-player-groups-create-\u003cstudioid>`,children:_jsx(_components.code,{children:`userplay player-groups create \u003cstudioId>`})}),`\n`,_jsx(_components.p,{children:`Create a player group`}),`\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:`--groupName`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Display name of the player group. (required)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--groupDescription`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`Optional description of the group’s purpose.`})]}),_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 seed the group with. New players are created as needed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--seedFromGroupIds`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`IDs of existing groups whose members are copied into the new group.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--playerIds`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`IDs of existing studio players to add to the group.`})]}),_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-player-groups-get-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups get \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`Get a player group`}),`\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:`groupId`})}),_jsx(_components.td,{children:`yes`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`userplay-player-groups-list-members-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups list-members \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`List a group’s members`}),`\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:`groupId`})}),_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-player-groups-remove-members-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups remove-members \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`Remove members from a group`}),`\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:`groupId`})}),_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:`--playerIds`})}),_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-player-groups-replace-members-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups replace-members \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`Replace a group’s members`}),`\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:`groupId`})}),_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 group’s complete membership, replacing the current members. (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-player-groups-update-\u003cstudioid>-\u003cgroupid>`,children:_jsx(_components.code,{children:`userplay player-groups update \u003cstudioId> \u003cgroupId>`})}),`\n`,_jsx(_components.p,{children:`Update a player group`}),`\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:`groupId`})}),_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:`--groupName`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`New display name for the group.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--groupDescription`})}),_jsx(_components.td,{children:`value`}),_jsx(_components.td,{children:`New description for the group. Pass null to clear it.`})]}),_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":"Player groups","description":"Reusable groups of players.","href":"/cli-reference/player-groups"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"userplay player-groups add-members \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-add-members-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]},{"title":"userplay player-groups create \u003cstudioId>","slug":"userplay-player-groups-create-\u003cstudioid>","depth":3,"children":[]},{"title":"userplay player-groups get \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-get-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]},{"title":"userplay player-groups list-members \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-list-members-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]},{"title":"userplay player-groups remove-members \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-remove-members-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]},{"title":"userplay player-groups replace-members \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-replace-members-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]},{"title":"userplay player-groups update \u003cstudioId> \u003cgroupId>","slug":"userplay-player-groups-update-\u003cstudioid>-\u003cgroupid>","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"userplay","siteName":"Userplay","title":"Player groups - Userplay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-22T08:40:56.035Z","originalFileLocation":"cli-reference/player-groups.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=\"Reusable groups of players.\">\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=\"Player groups - Userplay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reusable groups of players.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userplay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userplay.io/cli-reference/player-groups\">\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=Player+groups\u0026amp;description=Reusable+groups+of+players.\u0026amp;theme=8b51140b7ac8cec2b7b34f9b\u0026amp;signature=5e4bbae323ffdd56c469b609093976a618d9147f29712107bcc54db040c4d1e6\">\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=\"Player groups - Userplay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reusable groups of players.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://userplay.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=Player+groups\u0026amp;description=Reusable+groups+of+players.\u0026amp;theme=8b51140b7ac8cec2b7b34f9b\u0026amp;signature=5e4bbae323ffdd56c469b609093976a618d9147f29712107bcc54db040c4d1e6\">\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/player-groups\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli-reference/player-groups.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/player-groups#webpage\",\"url\":\"https://docs.userplay.io/cli-reference/player-groups\",\"name\":\"Player groups\",\"description\":\"Reusable groups of players.\",\"dateModified\":\"2026-07-22T08:40:56.035Z\",\"isPartOf\":{\"@id\":\"https://docs.userplay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userplay.io/cli-reference/player-groups#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userplay.io/cli-reference/player-groups#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commands\",\"item\":\"https://docs.userplay.io/cli-reference/config\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Player groups\",\"item\":\"https://docs.userplay.io/cli-reference/player-groups\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.userplay.io/cli-reference/player-groups#article\",\"headline\":\"Player groups\",\"name\":\"Player groups\",\"description\":\"Reusable groups of players.\",\"url\":\"https://docs.userplay.io/cli-reference/player-groups\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userplay.io/cli-reference/player-groups#webpage\"},\"dateModified\":\"2026-07-22T08:40:56.035Z\",\"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/player-groups.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","href":"/cli-reference/studios"},{"title":"Playtests","href":"/cli-reference/playtests"},{"title":"Surveys","href":"/cli-reference/surveys"},{"title":"Waitlists","href":"/cli-reference/waitlists"},{"title":"NDAs","href":"/cli-reference/ndas"},{"title":"Players","description":"A studio's player directory.","href":"/cli-reference/players"},{"title":"Player groups","href":"/cli-reference/player-groups"},{"title":"Key vaults","description":"Reusable vaults of distributable game keys.","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":"Player groups - Userplay","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}