Preview a category’s format («Formato»): the rounds it keeps and replaces (writes nothing)
Shows what applyDivisionFormat would do to the category, and writes nothing: the format’s rounds in play order (a group stage «Fase de Grupos», a knockout «Eliminatorias», or both in that order) with 1, 2 («2 sets (mejor de 3 sets o súper muerte)») or 5 sets, each KEPT (a leading round of the same type keeps its games, groups and results; its sets are updated) or NEW, and the current rounds it removes with their games. A round holding a result is never replaced (FORMAT_HAS_PLAYED_GAMES). A format with a group stage sets the tournament’s points table to the dashboard’s racket default (gamePointsDefault), as the format wizard does. Answers a confirmationToken (15 minutes) to send unchanged to applyDivisionFormat once the organizer approved this exact plan. Needs only the read scope.
Authorization
apiToken API token (organization or personal)
In: header
Path Parameters
Tournament identifier
uuidCategory identifier
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/external/tournaments/497f6eca-6276-4993-bfeb-53cbbbba6f08/divisions/497f6eca-6276-4993-bfeb-53cbbbba6f08/format/preview" \ -H "Content-Type: application/json" \ -d '{ "rounds": [ { "type": "ROUND_ROBIN_ROUND", "numberOfSets": 2 } ] }'{ "division": { "idx": "a7b8c9d0-e1f2-4345-8a6b-7c8d9e0f1a2b", "name": "Primera Varonil" }, "plan": { "rounds": [ { "position": 1, "type": "ROUND_ROBIN_ROUND", "label": { "es": "Fase de Grupos", "en": "Group stage" }, "numberOfSets": 2, "proSets": false, "outcome": "KEPT", "roundIdx": "3f1a2b3c-4d5e-4f60-8123-456789abcdef" } ], "replaced": [ { "roundIdx": "4a2b3c4d-5e6f-4071-8234-56789abcdef0", "label": { "es": "Fase de Grupos", "en": "Group stage" }, "games": 12, "played": 0 } ], "keptGames": 12, "gamePointsDefault": true }, "confirmationToken": "eyJ2IjoxLCJraW5kIjoiZGl2aXNpb24uZm9ybWF0In0.c2lnbmF0dXJl", "expiresAt": "2027-03-14T15:15:00.000Z"}