Games

Upsert Game

Changed on

Upsert a game record.

Inserts a new game or updates an existing one based on video_id. If game_id is not provided, a UUID will be auto-generated.

post/api/v1/games

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/games
  • Auth
    none declared. Required headers: x-api-key, League

Headers

x-api-keystring required

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

Request body

game_idstring uuid required

Game ID (must be a valid UUID)

home_team_idstring uuid required

Home team identifier (must be a valid UUID)

away_team_idstring uuid required

Away team identifier (must be a valid UUID)

seasonstring required

Season (e.g., '2026')

competition_idstring nullable

Stable league/competition identifier within the season (e.g., 'VIC'). Required for competition-scoped leagues such as AABL.

season_typestring required

Season type (e.g., 'regular season', 'playoffs')

scheduled_date_timestring date-time required

Scheduled game date and time (must include timezone, e.g., '2026-02-01T19:00:00+11:00' for Australia/Melbourne)

venuestring nullable

Game venue

game_statusstring required

Game status (e.g., 'scheduled', 'in progress', 'completed')

Example request

{
  "away_team_id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
  "competition_id": "VIC",
  "game_id": "550e8400-e29b-41d4-a716-446655440000",
  "game_status": "scheduled",
  "home_team_id": "60959335-3173-45b4-b656-276a05b22011",
  "scheduled_date_time": "2026-02-01T19:00:00+11:00",
  "season": "2026",
  "season_type": "regular season",
  "venue": "Arena Center"
}

Response

Successful Response

successboolean required

Whether the operation was successful

messagestring required

Status message

video_idstring required

The internal identifier of the created game record

competition_idstring nullable

Stable league/competition identifier for the game

webhooks_triggeredinteger

Number of newly reserved webhook deliveries. This is zero for non-terminal updates and already-delivered terminal events.

Changes

  • 9b0abde08b06Revision changes
    • breaking

      the header request parameter League became required

    • breaking

      the header request parameter x-api-key became required

    • breaking

      header request parameter League list-of-types was narrowed by removing types null

    • breaking

      header request parameter x-api-key list-of-types was narrowed by removing types null

    • info

      for the header request parameter League, the type was generalized from no type to string

    • info

      for the header request parameter x-api-key, the type was generalized from no type to string

  • edd51549cfb6Revision changes
    • info

      added the optional property to the response with the status