v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
Challenges

Cancel a challenge

Cancel a challenge you sent, or aborts the game if the challenge was accepted, but the game was not yet played. Note that the ID of a game is the same as the ID of the challenge that created it. Works for user challenges and open challenges alike.

post/api/challenge/{challengeId}/cancel

Path parameters

challengeIdstring required
Example:5IrD6Gzz

Query parameters

opponentTokenstring

Optional challenge:write token of the opponent. If set, the game can be canceled even if both players have moved.

Response

The challenge was successfully cancelled.

okboolean required