LIlichess
Broadcasts

Update your broadcast tournament

Update information about a broadcast tournament that you created. This endpoint accepts the same form data as the web form. All fields must be populated with data. Missing fields will override the broadcast with empty data.

post/broadcast/{broadcastTournamentId}/edit

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/broadcast/{broadcastTournamentId}/edit
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: study:write

Path parameters

broadcastTournamentIdstring required

The broadcast ID

Request body application/x-www-form-urlencoded

namestring required

Name of the broadcast tournament.

Example: Sinquefield Cup

markdownstring

Optional long description of the broadcast. Markdown is supported.

showScoresboolean

Show players scores based on game results

showRatingDiffsboolean

Show player's rating diffs

teamTableboolean

Show a team leaderboard. Requires WhiteTeam and BlackTeam PGN tags.

visibility'public' | 'unlisted' | 'private'

Who can view the broadcast.

  • public: Default. Anyone can view the broadcast
  • unlisted: Only people with the link can view the broadcast
  • private: Only the broadcast owner(s) can view the broadcast
playersstring

Optional replace player names, ratings and titles.

One line per player, formatted as such:

player name / FIDE ID

Example:

Magnus Carlsen / 1503014

Player names ignore case and punctuation, and match all possible combinations of 2 words: "Jorge Rick Vito" will match "Jorge Rick", "jorge vito", "Rick, Vito", etc.

If the player is NM or WNM, you can:

player name / FIDE ID / title

Alternatively, you may set tags manually, like so:

player name / rating / title / new name

All values are optional. Example:

Magnus Carlsen / 2863 / GM
YouGotLittUp / 1890 / / Louis Litt
teamsstring

Optional: assign players to teams

One line per player, formatted as such:

Team name; Fide Id or Player name

Example:

Team Cats ; 3408230
Team Dogs ; Scooby Doo

By default the PGN tags WhiteTeam and BlackTeam are used.

tier3 | 4 | 5

Optional, for Lichess admins only, used to feature on /broadcast.

  • 3 for Official: normal tier
  • 4 for Official: high tier
  • 5 for Official: best tier
tiebreaksBroadcastTiebreakExtendedCode[]

Example request

{
  "grouping": {
    "info": {
      "name": "Chess Olympiad | Open",
      "tours": "wYigbpXq\nM5YHvpOX\nq6ezoCXP\n"
    },
    "scoreGroups": [
      "wYigbpXq,M5YHvpOX"
    ]
  }
}

Response

The broadcast tournament was successfully edited.

okboolean required

Changes

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