Broadcasts

Update a broadcast round

Changed on

Update information about a broadcast round. 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. For instance, if you omit startDate, then any pre-existing start date will be removed.

post/broadcast/round/{broadcastRoundId}/edit

Request

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

Path parameters

broadcastRoundIdstring required

The broadcast round ID

Query parameters

patchboolean

Only update the provided fields, leaving others unchanged

Request body application/x-www-form-urlencoded

OR
OR
OR
OR

Response

The broadcast round was successfully edited.

isSubscribedboolean

Indicates if the user making the request is subscribed to the broadcast

photosBroadcastPhotos required

Photos of players, when available. The object keys are FIDE IDs

Changes

    • info

      added the optional property / to the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status