Lobby - Leave Lobby

Leave a lobby.

POST https://titleId.playfabapi.com/Lobby/LeaveLobby

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

LobbyId

string

The id of the lobby.

MemberEntity

EntityKey

The member entity leaving the lobby.

Responses

Name Type Description
200 OK

LobbyEmptyResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

LeaveLobbyRequest

Request to leave a lobby. Only a client can leave a lobby.

LobbyEmptyResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.

Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

LeaveLobbyRequest

Request to leave a lobby. Only a client can leave a lobby.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

LobbyId

string

The id of the lobby.

MemberEntity

EntityKey

The member entity leaving the lobby.

LobbyEmptyResult

Error Codes

Name Code
LobbyBadRequest 13007
LobbyDoesNotExist 13000
LobbyPlayerNotPresent 13006
LobbyRateLimitExceeded 13001