skip to Main Content

Fill out the Competitions and Contests Name, Availability and Description. Some fields are mandatory some are optional. The Settings section consists the basic information about the competition name, when the competition is available, description and metadata. You can check 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

An automatically calculated and implemented time that shows the time duration for how long the competition will run.

 

» Description String

Optional

The competition and contest description visible to players on the leaderboard.

 

The Description can be changed once the competition is created.

» Metadata Array[Object]

Optional

Optional information you can use to store reference information.

 

APP Example:

Label End of the year Competition
Availability from31/12/2019, 00:00 UTC
Availability until31/12/2019, 23:59 UTC
Container duration0days 23hours 59minutes
DescriptionA competition to commemorate the end of the year!
Metadata: KeyWinter
Metadata: Value1

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.

CONTINUE – Click Next and continue to the next step.

Back To Top