HIhify
Matches

Start a match

Transitions the match from pending to in_progress. Refused if another match on the same game is already live, since both would emit onto that game's score channel.

patch/v1/matches/{id}/start

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Response

Match started

idinteger
game_idinteger
sequence_numberinteger nullable
round_numberinteger nullable
stage'league' | 'quarterfinal' | 'semifinal' | 'knockout' | 'final' | 'third_place'

Where the match sits in the tournament

status'pending' | 'in_progress' | 'completed'
winner_side'side_a' | 'side_b' | 'draw' nullable
first_serve_side'side_a' | 'side_b' nullable

Side that served first; set via start_scoring

completion_reason'normal' | 'injury' | 'walkover' | 'other' nullable

How the match ended, set from the match_completed event: normal for a match played to its conclusion, injury/walkover/other for an early end. Null until the match completes.

category_labelstring nullable

Display category, e.g. "Open Mixed Doubles"

scoring_config_snapshotobject

The compiled rules the match is scored under, resolved from its scoring format (or its tournament's). Empty when neither names one.

started_atstring date-time nullable

scored_at of the first non-voided score entry; null until the match has been scored.

ended_atstring date-time nullable

scored_at of the last non-voided score entry; null until the match has been scored.

duration_secondsinteger nullable

ended_at minus started_at; null until a second entry exists.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 2 revisions of this API.