Skip to main content
POST
Leave Lobby As Server

Authorizations

X-EntityToken
string
header
required

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

Body

application/json

Preview: Request for server to leave a lobby. Only a game_server entity can leave and this is restricted to client owned lobbies which are using connections.

Preview: Request for server to leave a lobby. Only a game_server entity can leave and this is restricted to client owned lobbies which are using connections.

LobbyId
string
required

The id of the lobby.

ServerEntity
object
required

The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed. If a the given game_server entity is not in the lobby, it will fail.

CustomTags
object

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

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026