Match Upload & Management
All partners must have the ability to create, update, and delete matches.
Match Submission Requirements
To maintain data integrity, all match uploads must adhere to the following rules:
Authorized Submissions: Only tournament directors, admins, or designated match owners may submit results.
Player Eligibility: Every player included in the match must have the
BASIC_L1entitlement.Permissions: For club-related matches, the submitter must have the appropriate permissions for that specific club. See Club Integration for details.
Uploading a Match
Depending on your platform's needs, you can submit matches one at a time or in batches.
Singular Match Upload
Ideal for real-time score reporting immediately after a match concludes.
Production
Bulk Match Upload
Designed for syncing large event days or historical data. You may upload up to 100 matches in a single request.
Example Request Object
The structure for a single match is identical across both endpoints. For Bulk Upload, simply provide an array of these objects.
Handling the API Response
When a match is successfully created (singular or bulk), the API returns a response object containing unique identifiers. You must store these IDs in your database to manage the match lifecycle. The structure for a successful match creation is identical across both endpoints. For Bulk Upload, it is simply an array of these objects.
Bulk Response & Error Handling
For bulk uploads, the response contains an array of successes and errors. If a match fails (e.g., "Match with identifier already exists"), it will be listed in the errors array with a specific reason.
Managing the Match Lifecycle
Once a match is submitted, you may need to adjust it. These actions require the matchCode saved from the initial response.
Updating a Match
If a match needs to be updated, the original owner of the match or a trusted admin should have the functionality readily available on the platform.
Production
Deleting a Match
If a match needs to be deleted, the original owner of the match or a trusted admin should have the functionality readily available on the platform.
Production
Last updated