Challenges

Decline a challenge

Decline an incoming challenge.

post/api/challenge/{challengeId}/decline

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/challenge/{challengeId}/decline
  • 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

Request body application/x-www-form-urlencoded

reason'generic' | 'later' | 'tooFast' | 'tooSlow' | 'timeControl' | 'rated' | 'casual' | 'standard' | 'variant' | 'noBot' | 'onlyBot'

Reason the challenge was declined. Only the values listed below are accepted; any other value falls back to generic. The reason will be translated to the player's language.

Response

The challenge was successfully declined.

okboolean required

Changes

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