Step 1: Simple Competition settings

In the Settings section, fill in the Competition and Contest names, availability, description, and metadata. Some fields are mandatory, others are optional. You can read more about the Competitions model in our API documentation Competitions.

SETTINGS fields

EXAMPLES

» Label String

Mandatory

The Name of the competition and contest that the player sees in the leaderboard. The name is the same for the competition and contest.

The Label can be changed once the competition is created.

» Availability from Date/Time

Mandatory

Select the date (day/month/year) and time (hour: minute) when the competition and contest will start in UTC.

» Availability until DateTime

Mandatory

Select the date (day/month/year) and time (hour: minute) when the competition and contest will end in UTC.*

The End date/time of the competition must be at least 1 hour after the Start date/time.

» Container duration

Automated

The automatically calculated and implemented the time duration of the Competition.

» Description String

Optional

The Competition and Contest description are visible to players on the leaderboard.

The Description can be changed once the competition is created.

» Metadata Array[Object]

Optional

Optional information you can store for reference.

APP Example:

Label	End of the year Competition
Availability from	31/12/2019, 00:00 UTC
Availability until	31/12/2019, 23:59 UTC
Container duration	0days 23hours 59minutes
Description	A competition to commemorate the end of the year!
Metadata: Key	Winter
Metadata: Value	1

API Example:

{
    "jsonClass": "Competition",
    ...
    "label": "End of the year Competition",
    "options": {
        "autoStart": true,
        "autoStartRetryInterval": 1000,
        "autoStop": true,
        "autoStopRetryInterval": 1000,
        "scheduledDates": {
            "jsonClass": "StartEndDate",
            "start": "2019-12-31T00:00:00.000+0000",
            "end": "2019-12-31T23:59:00.000+0000"
        },
        "actualDates": {
            "jsonClass": "StartEndDate"
        },

    "description": "A competition to commemorate the end of the year!",
    "metadata": [
        {
            "jsonClass": "Metadata",
            "key": "Winter",
            "value": "1"
        }
    ],

    ...
}

The API example provides only a simplified version of the POST body. A full example of POST Competition can be found in the Competitions APP API documentationhere.

If any mandatory fields are missing, the field is shown in red, as in the example below.

MISSING ENTRIES

CONTINUE – Click Next and continue to the next step.