Skip to content
RallyHere Docs

Delete Platform Session From Rally Here Session

DELETE
/session/v1/platform/{platform}/platform-session/{platform_session_id_base64}/session/{session_id}

Remove a platform session from a Rally Here session

Required Permissions:

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

Required Session Permissions: SessionPermissions.active_in_session for users that do not have the session:update:any auth permission

Authorizations

Parameters

Path Parameters

platform
required

An enumeration.

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
platform_session_id_base64
required
string
>= 1 characters <= 4096 characters
session_id
required
string
>= 1 characters <= 128 characters

Query Parameters

refresh_ttl
boolean
default: true

Responses

204

Successful Response

403

User is not authenticated, or does not have sufficient role access to perform request

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

404

Platform Session or Platform Player doesn’t exist. See error code for more info

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

409

Service was unable to fulfill the request at this time and should be retried after the Retry-After wait time

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

Headers

Retry-After
integer

Number of seconds after which to retry the request

422

Validation Error

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