Skip to main content

FindMatchmakerLobbyForParty

Attempts to make the current identity's party find a lobby based on the given criteria.

If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

This request will use the party player count configured for the lobby group.

See FindLobby.

Header Parameters
  • origin string
Request Body required
  • game_modes string[] required

    Game modes to match lobbies against.

  • regions string[]

    Regions to match lobbies against. If not specified, the optimal region will be determined and will attempt to find lobbies in that region.

  • prevent_auto_create_lobby boolean

    Prevents a new lobby from being created when finding a lobby. If no lobby is found, MATCHMAKER_LOBBY_NOT_FOUND will be returned.

Responses

FindMatchmakerLobbyForParty 200 response