RequestMatchmakerPlayer
Attempts to create a new matchmaker player for the current identity.
If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin
event with all the information required to join the lobby.
Only relevant if the party is already in a matchmaker lobby.
When To Use This Endpoint
Joining a Party Already In a Lobby
When an identity joins a party that's already in a lobby, a new matchmaker
player will not automatically be created unless
JoinParty#matchmaker_auto_join_lobby is set to true.
Leaving the Game and Returning
If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.
Failed to Connect to Lobby or Disconnected From Lobby
If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.
- 200
- 400
- 403
- 404
- 408
- 429
- 500
RequestMatchmakerPlayer 200 response
BadRequestError 400 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.
ForbiddenError 403 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.
NotFoundError 404 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.
UnauthorizedError 408 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.
RateLimitError 429 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.
InternalError 500 response
Schema
- code string required
- message string required
- metadata
Unstructured metadata relating to an error. Must be manually parsed.