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

Description:

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

A competition can not be Canceled if a contest is still in Active state

A competition can not be Canceled if it is in Finished state

Resource URL:

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

Request header

Key	Value	Required
X-API-KEY		Yes
Content-Type	application/json	Yes

Request URL parameter

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account
id	String	Yes	Competition 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/Cancel

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": "Cancel",
        "statusCode": 9,
        "translatableFields": [
            "label",
            "description",
            "termsConditions"
        ]
    }
}

ERROR CODES

Code	HTTP Status	Description	Example
	404		Error Response 404 Expand source { "status": 404 }
3007	412	Invalid operation request.	Error Response 412 Expand source { "errors": [ { "message": "Invalid operation request.", "code": 3007, "status": 412 } ] }