LIlichess
Teams

Join a team

Join a team. If the team requires a password but the password field is incorrect, then the call fails with 403 Forbidden. Similarly, if the team join policy requires a confirmation but the message parameter is not given, then the call fails with 403 Forbidden.

post/team/{teamId}/join

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/team/{teamId}/join
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: team:write

Path parameters

teamIdstring required
Example:coders

Request body application/x-www-form-urlencoded

messagestring

Required if team manually reviews admission requests.

passwordstring

Optional password, if the team requires one.

Response

The request to join a team was successfully sent.

okboolean required

Changes

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