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

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/challenge/{challengeId}/cancel
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: challenge:write, bot:play, board:play

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

Changes

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