Game: Matches

Forfeit a match on behalf of one participating team

Changed on

Forfeits the match for the supplied team; the other participating team wins. Valid only while the match is ACCEPTED, READY, or IN_PROGRESS. Requires the game.lifecycle:read-write permission and a key bound to the match's game. Supports an optional Idempotency-Key request header: a retry with the same key and body replays the original response, while the same key with a different body returns 409 error_idempotency_key_conflict.

post/game/matches/{matchId}/forfeit

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/game/matches/{matchId}/forfeit
  • Auth
    HTTP bearer

Path parameters

matchIdstring required

Match ID.

Request body

forfeitingTeamIdstring required

ID of the team that forfeits. Must be a participant of the match.

reasonstring

Optional human-readable forfeit reason, recorded on the match.

Response

The match was forfeited successfully.

successtrue required
matchIdstring required

ID of the forfeited match.

forfeitedByTeamIdstring required

ID of the team that forfeited.

timestampstring required

Server response time (ISO 8601).

Changes