Skip to main content
POST
Create a player group

Authorizations

Authorization
string
header
required

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

Path Parameters

studioId
string
required

Body

application/json
groupName
string
required

Display name of the player group.

Required string length: 2 - 80
groupDescription
string

Optional description of the group's purpose.

Maximum string length: 2000
emails
string[]

Email addresses to seed the group with. New players are created as needed.

Maximum array length: 1000
Maximum string length: 320
seedFromGroupIds
string[]

IDs of existing groups whose members are copied into the new group.

playerIds
string[]

IDs of existing studio players to add to the group.

Response

201 - application/json

The created group

data
object
required