PUT /api/:space/competitions/:id/manage/Ready

Description:

Update Competitions status to Ready in the CompetitionLabs database for a given Competition identifier.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/competitions/<competitionId>/manage/Ready

Request header

KeyValueRequired
X-API-KEY

Yes
Content-Type
application/jsonYes

Request URL parameter

Parameter
Type
Required
Description
space
StringYesThis is the space name which is linked to the account
id
StringYesCompetition identifier retrieved from GET Competitions resource.

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/sD7ZUWUBeag0_3vrb6kW/manage/Ready
Response
{
    "data": {
        "jsonClass": "Competition",
        "accountId": "QmTaPGUBsZyUBGOR_u9A",
        "competitionType": "Leaderboard",
        "entrantMemberType": "Individual",
        "allowMultipleEntriesPerRound": true,
        "numberOfRounds": 1,
        "label": "test",
        "description": "",
        "termsConditions": "",
        "options": {
            "numberOfEntrants": {
                "jsonClass": "MaxMin",
                "minimum": 1
            },
            "products": [
                {
                    "jsonClass": "Product",
                    "name": "The Fruits",
                    "productType": "Slot",
                    "accountId": "QmTaPGUBsZyUBGOR_u9A",
                    "description": "Demo Fruits slot product",
                    "adjustmentFactor": 4.12,
                    "productRefId": "fruits",
                    "actionAdjustmentFactors": [],
                    "productGroups": [],
                    "created": "2018-08-15T09:11:52.063+00:00",
                    "id": "SWTbPGUBsZyUBGORB-__"
                }
            ],
            "ruleSets": [],
            "isPublic": true,
            "autoStart": true,
            "autoStartRetryInterval": 300000,
            "autoStop": true,
            "autoStopRetryInterval": 300000,
            "scheduledDates": {
                "jsonClass": "StartEndDate",
                "start": "2018-08-19T11:02:06.000+00:00",
                "end": "2018-08-19T11:12:06.000+00:00"
            },
            "actualDates": {
                "jsonClass": "StartEndDate"
            },
            "limitEntrantsTo": [
                "$ALL"
            ],
            "optinRequiredForEntrants": false,
            "useGlobalEvents": true
        },
        "metadata": [],
        "created": "2018-08-19T11:02:13.711+00:00",
        "id": "sD7ZUWUBeag0_3vrb6kW",
        "translations": {},
        "status": "Ready",
        "statusCode": 9,
        "translatableFields": [
            "label",
            "description",
            "termsConditions"
        ]
    }
}

ERROR CODES

CodeHTTP StatusDescriptionExample

404
Error Response 404
{
    "status": 404
}
3007412Invalid operation request.
Error Response 412
{
    "errors": [
        {
            "message": "Invalid operation request.",
            "code": 3007,
            "status": 412
        }
    ]
}