Skip to content

Kick Session From Session

DELETE
/session/v1/session/{session_id}/kicked-session/{kicked_session_id}

Remove players from a session, {kicked_session_id}, if they are also in the session {session_id}

Required Permissions:

  • For any player (including themselves) : session:*

to kick any session regardless of membership status

Required Permissions:

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

to invite a session you are part of

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters
kicked_session_id
required
string
>= 1 characters <= 128 characters

Responses

204

Successful Response

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