Skip to content

Leave Queue

DELETE
/session/v1/session/{session_id}/queue

Remove session from a matchmaking queue

Required Permissions:

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

Required Session Permissions: SessionPermissions.session_admin

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Query Parameters

reason
string
Allowed values: assigned left_queue timeout party_changed
refresh_ttl
boolean
default: true

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