Matchmaking

Tests a user's saved start place in a universe against the place checks gamejoin makes.

Changed on
get/matchmaking-api/v1/matchmaking/universe/{universeId}/start-place/test

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/matchmaking-api/v1/matchmaking/universe/{universeId}/start-place/test
  • Auth
    none required

Path parameters

universeIdinteger required

Query parameters

userIdinteger

Response

Success

result'Invalid' | 'Found' | 'NoOverrideConfigured' | 'DataStoreEntryNotFound' | 'DataStoreNotFound' | 'DataStoreError' | 'FieldMissing' | 'ValueParseFailure' | 'PlaceNotInExperience' | 'PlaceNotPublished'

Whether a user's saved start place passed every check, and if not, why.

placeIdinteger nullable

The place id read from the user's data store entry. Null when no place id could be read.

Changes