Create Matchmade Session
POST /session/v1/match-made-session
Create a match session based on matchmaking results.
Required Permissions:
- For any player (including themselves) any of:
session:*
,session:create:matchmade
Required Session Permissions: None
Authorizations
Request Body required
A request body for a new matchmade session to be created
object
List of teams that are to be invited to session
A team of SessionPlayers in a session
object
Players currently on this team
A player resource in a session
object
Legacy id for this player
UUID for this player
Status of the player in the session
UUID of the player who sent this players invite, if any
The UUID of the session that this player was invited from
Player-defined custom data
object
Product Client Version number. Used for compatibility checking with other players and instances
Which input type and platform the client is using
object
DEPRECATED. Use ‘platform’ instead. Id for which platform this client is on. ID will be ignored if ‘platform’ is given. At least one of the two is required
Which platform this client is on. If one is not provided, will get the platform from the ‘platform_id’. At least one of the two is required
Which input type this client is using
Client’s desired crossplay settings to determine which other clients it can play with. If not defined, assumed to be as permissive as possible
object
The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)
The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Maximum number of players allowed on this team
Which team this is
Matchmaking tickets that were assigned to this team
Custom data about this team
object
List of sessions and tickets the match was made with. Used to verify this match should still be created. Takes priority over the session list. One of the two is required
object
List of sessions that should be a part of this matchmade session. Used if session_tickets is empty. One of the two is required
DEPRECATED. Which launch template should be used to request an instance
DEPRECATED. Which launch template should be used to request an instance
Region to start the instance in
Unique ID for this generated match
Custom data about the match
object
Player UUID of the host, if the host type is player
ID for the open-match backfill object
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
The evaluation score sent to the open-match evaluator
The calculated rank quality of the match. Often matches the evaluation score
The MatchMakingProfileID that was ultimately used to create this match
Responses
200
Successful Response
403
Forbidden
object
404
Session doesn’t exist or Player is not a member of the session. See error code for more info
object
422
Validation Error