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

• HTTPBearerHeadersOrCookie

Request Body ^required

A request body for a new matchmade session to be created

object

teams

required

List of teams that are to be invited to session

Array<object>

A team of SessionPlayers in a session

object

players

required

Players currently on this team

Array<object>

A player resource in a session

object

player_id

Legacy id for this player

integer

player_uuid

required

UUID for this player

string format: uuid

status

required

Status of the player in the session

string

Allowed values: leader member invited reserved

inviting_player_uuid

UUID of the player who sent this players invite, if any

string format: uuid

source_session_id

The UUID of the session that this player was invited from

string

>= 1 characters <= 128 characters

custom_data

Player-defined custom data

object

key

additional properties

string

>= 1 characters <= 4096 characters

version

Product Client Version number. Used for compatibility checking with other players and instances

string format: semver

21.3.15-beta+12345

client_settings

Which input type and platform the client is using

object

platform_id

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

integer

platform

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

string

Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName

input

required

Which input type this client is using

string

Allowed values: keyboardandmouse gamepad touch

crossplay_preferences

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

permitted_platform

required

The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)

string

Allowed values: desired_platforms_any desired_platforms_xboxlike desired_platforms_playstationlike

permitted_input

required

The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)

string

Allowed values: desired_inputs_any desired_inputs_keyboardandmouse desired_inputs_gamepad desired_inputs_touch

invited

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

joined

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

max_size

required

Maximum number of players allowed on this team

integer

>= 1 <= 100

team_id

Which team this is

integer

ticket_ids

Matchmaking tickets that were assigned to this team

Array<string>

custom_data

Custom data about this team

object

key

additional properties

string

>= 1 characters <= 4096 characters

session_tickets

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

key

additional properties

string

sessions

List of sessions that should be a part of this matchmade session. Used if session_tickets is empty. One of the two is required

Array<string>

instance_launch_template_id

DEPRECATED. Which launch template should be used to request an instance

string format: uuid

instance_request_template_id

DEPRECATED. Which launch template should be used to request an instance

string format: uuid

region_id

required

Region to start the instance in

string

>= 1 characters <= 128 characters

match_id

required

Unique ID for this generated match

string

custom_data

Custom data about the match

object

key

additional properties

string

>= 1 characters <= 4096 characters

host_player_uuid

Player UUID of the host, if the host type is player

string format: uuid

backfill_id

ID for the open-match backfill object

string

>= 1 characters

match_create_request_time

required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

evaluation_score

The evaluation score sent to the open-match evaluator

number

rank_quality

The calculated rank quality of the match. Often matches the evaluation score

number

match_making_profile_id

required

The MatchMakingProfileID that was ultimately used to create this match

string

>= 1 characters <= 128 characters

Responses

200

Successful Response

403

Forbidden

object

auth_success

boolean

default: true

error_code

required

string

desc

required

string

404

Session doesn’t exist or Player is not a member of the session. See error code for more info

object

auth_success

boolean

default: true

error_code

required

string

desc

required

string

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string