Matchmaking - Notify Matchmaker Player Left

Informs the PlayFab match-making service that the user specified has left the Game Server Instance

POST https://titleId.playfabapi.com/Server/NotifyMatchmakerPlayerLeft

Request Header

Name Required Type Description
SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
LobbyId True
  • string

Unique identifier of the Game Instance the user is leaving.

PlayFabId True
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

NotifyMatchmakerPlayerLeftRequest
NotifyMatchmakerPlayerLeftResult
PlayerConnectionState

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

NotifyMatchmakerPlayerLeftRequest

Name Type Description
LobbyId
  • string

Unique identifier of the Game Instance the user is leaving.

PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

NotifyMatchmakerPlayerLeftResult

Name Type Description
PlayerState

State of user leaving the Game Server Instance.

PlayerConnectionState

Name Type Description
Connecting
  • string
Participated
  • string
Participating
  • string
Unassigned
  • string

Error Codes

Name Code
GameNotFound 1024