Game: Matches

Create a two-sided game-originated match

Changed on

Creates an ACCEPTED + PUBLISHED match for the API key's bound game between two active teams in that game. Requires the game.lifecycle:read-write permission. Supply an optional Idempotency-Key request header to make retries safe: an identical key + body replays the original response, while the same key with a different body returns 409 error_idempotency_key_conflict.

post/game/matches/create

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/game/matches/create
  • Auth
    HTTP bearer

Request body

creatorTeamIdstring required

ID of the creating team. Must belong to the key's bound game.

acceptedTeamIdstring required

ID of the opposing team. Required - game-originated matches are two-sided. Must belong to the key's bound game.

gameModeIdstring required

Game mode identifier (e.g. search_and_destroy).

bestOf1 | 3 | 5 | 7 required

Number of maps in the series. One of 1, 3, 5, or 7.

teamSizenumber required

Players per team (validated against the game's min/max).

platform'PC' | 'XBOX' | 'PLAYSTATION' | 'CONSOLE_ONLY' | 'CROSSPLAY' required

Match platform (e.g. CROSSPLAY).

inputDevice'ALL' | 'CONTROLLER' | 'KB_M' required

Allowed input device (e.g. ALL).

region'NONE' | 'NA_EAST' | 'NA_WEST' | 'EU' | 'ASIA' | 'OCEANIA' | 'SOUTH_AMERICA' | 'MIDDLE_EAST' | 'AFRICA' required

Match region (e.g. NONE).

mapSelectionType'COMPETITIVE' | 'FLEX' required

Map selection type (COMPETITIVE or FLEX).

mapPreferenceMode'PREFERRED' | 'VETO' | 'MANUAL' required

Map preference mode (PREFERRED, VETO, or MANUAL).

selectedMapsstring[]

Optional pre-selected map IDs.

selectedObjectivesstring[]

Optional pre-selected objective IDs.

scheduledAtnumber

Optional scheduled start time (epoch ms).

Response

The created match's ID.

successtrue required
matchIdstring required

ID of the newly created match.

timestampstring required

Server response time (ISO 8601).

Changes

  • 82f2480cdb83Revision changes
    • info

      api tag Game: Matches added

    • info

      api tag Game removed

  • 4bed7522e6f8Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 3.00 enum value to the request property

    • info

      added the new 5.00 enum value to the request property

    • info

      added the new 7.00 enum value to the request property