⚽ Convocados Docs GitHub

Players API

POST /api/events/[id]/players

Add a player to the event.

Request body

FieldTypeRequiredDescription
namestringYesPlayer name (max 50 chars, trimmed)

Headers (optional)

HeaderDescription
X-Client-IdClient identifier — used to suppress self-notifications

Example

curl -X POST https://convocados.fly.dev/api/events/EVENT_ID/players \
  -H "Content-Type: application/json" \
  -d '{ "name": "Alice" }'

Response

{ "ok": true }

Errors

CodeReason
400Name is empty
404Event not found
409Player name already exists in this event

DELETE /api/events/[id]/players

Remove a player from the event.

Request body

FieldTypeRequiredDescription
playerIdstringYesThe player's ID

Example

curl -X DELETE https://convocados.fly.dev/api/events/EVENT_ID/players \
  -H "Content-Type: application/json" \
  -d '{ "playerId": "clx..." }'

Side effects

GET /api/events/[id]/known-players

Get player name suggestions from game history. Returns names sorted by frequency, excluding current players.

Response

{
  "players": [
    { "name": "Alice", "gamesPlayed": 5 },
    { "name": "Bob", "gamesPlayed": 3 }
  ]
}

Returns up to 30 suggestions. Only includes names from "played" (not cancelled) history entries.