Skip to main content

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

Request​

Body

required

    teams

    object[]

    required

    List of teams that are to be invited to session

  • Array [

    • players

    object[]

    required

    Players currently on this team

  • Array [

    • player_id Player Id (integer)

    Legacy id for this player

    player_uuid uuidrequired

    UUID for this player

    status SessionPlayerStatus (string)required

    Possible values: [leader, member, invited, reserved]

    What membership state players have in a session

    inviting_player_uuid uuid

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

    source_session_id Source Session Id (string)

    Possible values: non-empty and <= 128 characters

    The UUID of the session that this player was invited from

    custom_data

    object

    player-defined custom data

    property name* string
    version semver

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

    client_settings

    object

    A player's platform and input settings

    platform_id PlatformID (integer)

    Possible values: [2, 4, 5, 9, 10, 11, 13, 16, 22, 24, 26, 28]

    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

    platform Platform (string)

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    Which platform this client is on. If one is not provided, will get the platform from the 'platform_id'. Platform is now read from client's authorization claims if available

    input Input (string)required

    Possible values: [keyboardandmouse, gamepad, touch]

    Which input type this client is using

    device_type DeviceType (string)

    Possible values: [pc, xbox_series, xbox_one, web]

    Platform verified device type for this client

    crossplay_preferences

    object

    A session's or player's preferences around crossplay platforms and inputs. Permitted platforms and inputs will be checked when new players attempt to join a session

    permitted_platform CrossplayPlatform (string)required

    Possible values: [desired_platforms_any, desired_platforms_xboxlike, desired_platforms_playstationlike]

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

    permitted_input CrossplayInput (string)required

    Possible values: [desired_inputs_any, desired_inputs_keyboardandmouse, desired_inputs_gamepad, desired_inputs_touch]

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

    invited date-time

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

    joined date-time

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

    session_permissions IntraSessionPermissions (string)[]

    Possible values: [invite, kick, move]

    Default value: ``

    A list of intra session permissions granted to this specific player

  • ]

    • max_size Max Size (integer)required

    Possible values: >= 1 and <= 100

    Maximum number of players allowed on this team

    team_id Team Id (integer)

    Which team this is

    ticket_ids string[]

    Matchmaking tickets that were assigned to this team

    custom_data

    object

    Custom data about this team

    property name* string

  • ]

    • session_tickets

    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

    property name* string
    sessions string[]

    Possible values: non-empty and <= 128 characters

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

    instance_launch_template_id uuid

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

    instance_request_template_id uuid

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

    region_id Region Id (string)required

    Possible values: non-empty and <= 128 characters

    Region to start the instance in

    match_id Match Id (string)required

    Unique ID for this generated match

    custom_data

    object

    Custom data about the match

    property name* string
    host_player_uuid uuid

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

    backfill_id Backfill Id (string)

    Possible values: non-empty

    ID for the open-match backfill object

    match_create_request_time date-timerequired

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

    evaluation_score Evaluation Score (number)

    The evaluation score sent to the open-match evaluator

    rank_quality Rank Quality (number)

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

    match_making_profile_id Match Making Profile Id (string)required

    Possible values: non-empty and <= 128 characters

    The MatchMakingProfileID that was ultimately used to create this match

Responses​

Successful Response

Schema

    any

Loading...