Update Team By Id
PATCH /session/v1/session/{session_id}/team/{team_id}
Update specific team info by session and team id
For all sessions:
-
Required auth permissions are any of:
session:*
,session:update:any
-
Required session permissions are None
For sessions you are actively in:
-
Required auth permissions are any of:
session:*
,session:update:any
,session:update:self
-
Required session permissions are
SessionPermissions.session_admin
Authorizations
Parameters
Path Parameters
Query Parameters
Request Body required
An update to a specific team’s number of max players
object
Maximum number of players for this team
Custom data about this team
object
Responses
200
Successful Response
A team of SessionPlayers in a session
object
Players currently on this team
A player resource in a session
object
Legacy id for this player
UUID for this player
Status of the player in the session
UUID of the player who sent this players invite, if any
The UUID of the session that this player was invited from
Player-defined custom data
object
Product Client Version number. Used for compatibility checking with other players and instances
Which input type and platform the client is using
object
DEPRECATED. Use ‘platform’ instead. Id for which platform this client is on. ID will be ignored if ‘platform’ is given. At least one of the two is required
Which platform this client is on. If one is not provided, will get the platform from the ‘platform_id’. At least one of the two is required
Which input type this client is using
Client’s desired crossplay settings to determine which other clients it can play with. If not defined, assumed to be as permissive as possible
object
The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)
The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Maximum number of players allowed on this team
Which team this is
Matchmaking tickets that were assigned to this team
Custom data about this team
object
Headers
Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.
403
Forbidden
object
422
Validation Error