Create a broadcast round

POST

https://lichess.org/broadcast/:broadcastTournamentId/new

POST

/broadcast/:broadcastTournamentId/new

curl -X POST https://lichess.org/broadcast/broadcastTournamentId/new \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "name=string"

{
  "round": {
    "id": "UpDXGrhz",
    "name": "Final Round",
    "slug": "final-round",
    "createdAt": 1760452032086,
    "rated": false,
    "url": "https://lichess.org/broadcast/knight-invitational/final-round/UpDXGrhz",
    "ongoing": true,
    "startsAt": 1760452032087
  },
  "tour": {
    "id": "dkGBWEoa",
    "name": "Knight Invitational",
    "slug": "knight-invitational",
    "createdAt": 1760452031769,
    "url": "https://lichess.org/broadcast/knight-invitational/dkGBWEoa",
    "dates": [
      1760455631824
    ],
    "info": {},
    "tier": 5
  },
  "study": {
    "writeable": true,
    "features": {
      "chat": true,
      "computer": true,
      "explorer": true
    }
  }
}

Create a new broadcast round to relay external games. This endpoint accepts the same form data as the web form.

Choose one between syncUrl, syncUrls, syncIds and syncUsers, if it is missing, the broadcast needs to be fed by pushing PGN to it

Authentication

AuthorizationBearer

Read the introduction for how to make authenticated requests.

Path parameters

broadcastTournamentIdstringRequired=8 characters

The broadcast tournament ID

Request

This endpoint expects an object.

send games via pushobjectRequired

retrieve games via PGN urlobjectRequired

retrieve games via mutiple PGN urlsobjectRequired

retrieve games via Lichess game IDsobjectRequired

retrieve games via Lichess usernamesobjectRequired

Response

The broadcast round was successfully created.

roundobject

tourobject

studyobject

Errors

400

Bad Request Error