Lobby - Delete Lobby

Service:

Multiplayer

API Version:

240426

Delete a lobby.

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

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.

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
DeleteLobbyRequest	Request to delete a lobby. Only servers can delete lobbies.
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

DeleteLobbyRequest

Request to delete a lobby. Only servers can delete lobbies.

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.

LobbyEmptyResult

Error Codes

Name	Code
LobbyBadRequest	13007
LobbyDoesNotExist	13000
LobbyRateLimitExceeded	13001