Skip to content

Update Session Player By Id

Deprecated
POST
/session/v1/session/{session_id}/player/id/{player_id}

Add or invite a player to the session, or change the status of a player already in the session

Required Permissions:

  • For any player (including themselves) any of: session:promote:self, session:promote:any, session:*

Required Session Permissions: None if session is publicly joinable or the player has been invited. SessionPermissions.session_admin for other operations

DEPRECATED - Use the player endpoint instead

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters
player_id
required
integer

Request Body required

A request body to update information about a player in a session

object
status

Status that the player would like after the request is complete. Note that some join operations may promote the player from member to leader

string
Allowed values: leader member invited reserved
team_id
required

Which team the player should be on

integer
custom_data

Player-defined custom data

object
key
additional properties
string
>= 1 characters <= 4096 characters
overflow_action

How we should handle too many players being invited to the chosen team

string
Allowed values: fail allow_overflow partial_with_overflow partial_without_overflow overfill

Responses

200

Successful Response

Response to a request to update a player in a session

object
player_uuid

Player UUID of the player updated

string format: uuid
status
required

Status of the player after the request is completed

string
Allowed values: leader member invited reserved
team_id
required

Which team the player joined

integer
custom_data

Resulting custom data about the player

object
key
additional properties
string
>= 1 characters <= 4096 characters

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Session doesn’t exist or Player is not a member of the session. See error code for more info

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string