Step 1: Advanced Competition settings

Fill out the Competitions Name, Availability, and Description. Some fields are mandatory; some are optional. You can check more about the Competitions model in our API documentation Competitions.

The Settings section consists of the basic information about the competition name when the competition is available, description, and metadata. 

SETTINGS

EXAMPLES

Name

Required

String

The Name of the competition that is exposed on the front end

Availability
from

Required

DateTime

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

until

Required

DateTime

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

Container duration
N/A

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

Description

Optional

String

The competition description that is visible to players. 
Metadata

Optional

Array [Object]

Optional information you can use to store reference information. 

APP Example:

Name
Summer End Competition
Availability
from

01/09/2019, 12:00 UTC

until
01/09/2019, 14:00 UTC
Container duration
0days 2hours 0minutes
Description
A competition to commemorate the end of summer!
Metadata
KeySummer
Value1

API Example:

{
    "jsonClass": "Competition",
    ...
    "label": "Summer End Competition",
    "autoStart": true,
    "autoStartRetryInterval": 1000,
    "autoStop": true,
    "autoStopRetryInterval": 1000,
    "scheduledDates": {
        "jsonClass": "StartEndDate",
        "start": "2019-09-01T12:00:00.000+00:00",
        "end": "2019-09-01T14:00:00.000+00:00"
    },
    "actualDates": {
        "jsonClass": "StartEndDate"
    },
    "description": "Demo Fruits slot product",
    "metadata": [
        {
        "jsonClass": "Metadata",
            "key": "Summer",
            "value": "1"
        }
    ],
    ...
}

A full example of POST Competition can be found in the Competitions APP API documentation here


CONTINUE Click Next and continue to the next step.

MISSING ENTRIES If any required information is missing, the field shows in red, as in the example below.