PUT /api/:space/competitions/:competitionId/contests/:contestId

Description:

Update a contest for a given ID.

A reward can not be updated with a contest. All the rewards that need to be updated within a contest have to be deleted by inserting the reward Id in the "deleteRewards" parameter and new ones will be created by inserting the reward model in the "rewards" parameter.

Resource URL:

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

Request header

Key	Value	Required
X-API-KEY	Your unique 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
competitionId	String	Yes	Competition identifier retrieved from GET Competitions resource
contestId	String	Yes	Contest identifier retrieved from GET contests request

Put body parameter

Parameter	Type	Required	Description
competitionId	String	Yes	Competition identifier retrieved from GET Competitions resource
number	Integer	Yes	Contests position e.g. if there are 2 Contests which one is first and which one is second. The default is 0
label	String	Yes	A name of the Contest
description	String	Optional	Description of the Contest
termsConditions	String	Optional	Terms and conditions of a Contest
round	Integer	Yes	To what round does the contest belong. The default is 1
roundType	String	Yes	Type of rounds in a contest, eg. TimeBound
entrantsFromContest	Array [String]	Optional	Array of Strings to identify which entrants will progress to next contest, for the first round the value should be 0 or can be left empty
options	Object	Yes	From Options domain model the only entries that are required:		Type	Required	Description
			numberOfEntrants	From `numberOfEntrants` model	Integer	Yes	Maximum and Minimum number of entrants
				`minimum`	Integer	Yes	The minimum number of entrants. The default is 1
				`maximum`	Integer	Optional	The maximum number of entrants. Left empty means that no limitations are added
			scheduledDates	From `scheduleDates` model	DateTime	Yes	StartEndDate model
				`start`	DateTime	Yes	Time and date of when the contest has to start. Example: 2019-09-24T14:25:00.000+00:00
				`end`	DateTime	Yes	Time and date of when the contest has to end. ISO8601 timestamp. Example: 2019-09-24T14:25:00.000+00:00
			`products`		Array [Object]	Optional	A list of Products
			`ruleSets`		Array [Object]	Yes	A list of RuleSets
			`autoStart`		Boolean	Optional	True means that the contest will auto start depending on the scheduledDates
			`autoStop`		Boolean	Optional	True means that the contest will auto stop depending on the scheduledDates
			`optinRequiredForEntrants`		Boolean	Yes	If True, members must Opt in before they can acquire points in the contest
			All the other entries		Object	Optional	All the other entries are optional to use
`metadata`	Array [Object]	Optional	A list of MetaData
`status`	String	No	A status of a contest. Creating a contest in a competition that hasn't been started yet the contest is automatically set to NotStarted or creating a contest in a competition that has already been started then the contest is set to Active.
`statusCode`	Integer	No	A status of a contest defined as a number. Creating a contest in a competition that hasn't been started yet the contest is automatically set to 0 (NotStarted) or creating a contest in a competition that has already been started then the contest is set to 3 (Active).
`reward`	Array [Object]	Optional	A model of a Reward	Type	Required	Description
			`entityId`	String	Yes	A contest Id. The string has to be left empty as it will populate automatically when the contest will be created
			`rewardRank`	String	Yes	It associates with the rank of the leaderboard
			`rewardName`	String	Yes	The name of a reward
			`value`	Integer	Yes	Numerical value of the reward that will be issued based on the reward type
			`rewardType`	String	Yes	Reward type identifier retrieved from GET RewardTypes resource
			`description`	String	Optional	The description of a Reward
			`delay`	Integer	Optional	Delay of issuing a reward in minutes
			`memberAcknowledgmentRequired`	Boolean	Optional	Requires member acknowledgment to claim a reward. If set to True reward will not be automatically issued
			`metadata`	Array [Object]	Optional	A list of Metadata
			`pointInTime`	DateTime	Optional	Reward is available until a specific point in time

EXAMPLE

Request

curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request PUT https://app.competitionlabs.com/api/<your-space-name>/competitions/iLMexGUBOmEkXOJnG2MB/contests/n7MkxGUBOmEkXOJnoGMo
-d '{ "contest": { "competitionId": "8vDwZ20BmZKDVA-UDqap", "number": 0, "label": "Test", "description": "", "termsConditions": "", "round": 1, "roundType": "TimeBound", "options": { "numberOfEntrants": { "jsonClass": "MaxMin", "minimum": 1 }, "products": [], "ruleSets": [{ "jsonClass": "RuleSet", "priority": 1, "scope": "contest", "action": "contest.points.calculated.by", "conditions": [{ "jsonClass": "MainConditionSet", "matchCondition": "All", "mustEvaluateTo": true, "rules": [{ "jsonClass": "MainRule", "fact": "event.action.type", "operator": "==", "constant": "bet" }]}]},{ "jsonClass": "RuleSet", "priority": 2, "scope": "contest", "action": "open.contest", "conditions": [{ "jsonClass": "MainConditionSet", "matchCondition": "All", "mustEvaluateTo": true, "rules": [{ "jsonClass": "MainRule", "fact": "contest.parents.status", "operator": "==", "constant": "$finalised.status" }]}]},{ "jsonClass": "RuleSet", "priority": 3, "scope": "contest", "action": "finish.contest", "conditions": [{ "jsonClass": "MainConditionSet", "matchCondition": "All", "mustEvaluateTo": true, "rules": [{ "jsonClass": "MainRule", "fact": "contest.active.elapsed", "operator": ">=", "constant": "$competition.scheduled.end" }]}]},{ "jsonClass": "RuleSet", "priority": 4, "scope": "contest", "action": "finalise.contest", "conditions": [{ "jsonClass": "MainConditionSet", "matchCondition": "All", "mustEvaluateTo": true, "rules": [{ "jsonClass": "MainRule", "fact": "contest.finish.elapsed", "operator": ">=", "constant": "1" }]}]}], "autoStart": true, "autoStop": true, "scheduledDates": { "jsonClass": "StartEndDate", "start": "2019-09-27T14:25:00.000+00:00", "end": "2019-09-24T15:25:00.000+00:00" }, "optinRequiredForEntrants": false }}, "rewards": [{ "jsonClass": "Reward", "entityId": "", "rewardRank": "2", "rewardName": "Test", "value": 1.0, "rewardType": "GuyNjGYBZ-qHKtWie_x4", "description": "", "memberAcknowledgmentRequired": false, "metadata": [], "pointInTime": "2019-09-24T14:03:14.204+00:00" }], "deleteRewards": ["Ow0faG0BY3Ny-K3H2een"]}'

Response

{
    "data": {
        "jsonClass": "Contest",
        "accountId": "FuyNjGYBZ-qHKtWicfwh",
        "competitionId": "CfAeaG0BmZKDVA-Uzacw",
        "number": 0,
        "label": "Test",
        "description": "",
        "round": 1,
        "roundType": "TimeBound",
        "entrantsFromContest": [],
        "options": {
            "numberOfEntrants": {
                "jsonClass": "MaxMin",
                "minimum": 1
            },
            "products": [],
            "ruleSets": [
                {
                    "jsonClass": "RuleSet",
                    "priority": 1,
                    "scope": "contest",
                    "action": "contest.points.calculated.by",
                    "conditions": [
                        {
                            "jsonClass": "MainConditionSet",
                            "matchCondition": "All",
                            "mustEvaluateTo": true,
                            "rules": [
                                {
                                    "jsonClass": "MainRule",
                                    "fact": "event.action.type",
                                    "operator": "==",
                                    "constant": "bet"
                                }
                            ]
                        }
                    ]
                },
                {
                    "jsonClass": "RuleSet",
                    "priority": 2,
                    "scope": "contest",
                    "action": "open.contest",
                    "conditions": [
                        {
                            "jsonClass": "MainConditionSet",
                            "matchCondition": "All",
                            "mustEvaluateTo": true,
                            "rules": [
                                {
                                    "jsonClass": "MainRule",
                                    "fact": "contest.parents.status",
                                    "operator": "==",
                                    "constant": "$finalised.status"
                                }
                            ]
                        }
                    ]
                },
                {
                    "jsonClass": "RuleSet",
                    "priority": 3,
                    "scope": "contest",
                    "action": "finish.contest",
                    "conditions": [
                        {
                            "jsonClass": "MainConditionSet",
                            "matchCondition": "All",
                            "mustEvaluateTo": true,
                            "rules": [
                                {
                                    "jsonClass": "MainRule",
                                    "fact": "contest.active.elapsed",
                                    "operator": ">=",
                                    "constant": "$competition.scheduled.end"
                                }
                            ]
                        }
                    ]
                },
                {
                    "jsonClass": "RuleSet",
                    "priority": 4,
                    "scope": "contest",
                    "action": "finalise.contest",
                    "conditions": [
                        {
                            "jsonClass": "MainConditionSet",
                            "matchCondition": "All",
                            "mustEvaluateTo": true,
                            "rules": [
                                {
                                    "jsonClass": "MainRule",
                                    "fact": "contest.finish.elapsed",
                                    "operator": ">=",
                                    "constant": "1"
                                }
                            ]
                        }
                    ]
                }
            ],
            "isPublic": true,
            "autoStart": true,
            "autoStartRetryInterval": 1000,
            "autoStop": true,
            "autoStopRetryInterval": 1000,
            "scheduledDates": {
                "jsonClass": "StartEndDate",
                "start": "2019-09-27T14:25:00.000+00:00",
                "end": "2019-09-24T15:25:00.000+00:00"
            },
            "actualDates": {
                "jsonClass": "StartEndDate"
            },
            "optinRequiredForEntrants": false,
            "useGlobalEvents": false
        },
        "created": "2019-09-25T11:13:00.443+00:00",
        "id": "DvAfaG0BmZKDVA-U2Kcb",
        "translations": {},
        "status": "NotStarted",
        "statusCode": 0,
        "translatableFields": [
            "label",
            "description",
            "termsConditions"
        ]
    }
}

ERROR CODES

Code	HTTP Status	Description	Example
1007	404	Contest with CL-contestId not found.	Error Response 404 Expand source { "errors": [ { "message": "Contest with CL-contestId: DvAfaG0BmZKDVA-U2Kcba not found.", "code": 1007, "status": 404 } ] }
1001	400	`number` parameter was excluded; `label` parameter was excluded; `competitionId` parameter was excluded; `round` parameter was excluded; `roundType` parameter was excluded;	Error Response 400 Expand source { "errors": [ { "message": "Could not extract contest, make sure that the model is correctly defined", "code": 1001, "status": 400 } ] }
1001	400	`entityId` parameter was excluded; `rewardRank` parameter was excluded; `rewardName` parameter was excluded; `value` parameter was excluded; `rewardType` parameter was excluded; `description` parameter was excluded;	Error Response 400 Expand source { "errors": [ { "message": "Could not extract rewards, make sure that the models is correctly defined", "code": 1001, "status": 400 } ] }
2023	409	Rules cannot be empty	Error Response 409 Expand source { "errors": [ { "message": "Rules cannot be empty.", "code": 2023, "status": 409 } ] }
3008	412	Contest parameters are locked for a contest in Active status Contest parameters are locked for a contest in Canceled status Contest parameters are locked for a contest in Finished status	Error Response 412 Expand source { "errors": [ { "message": "Invalid operation request. Contest parameters are locked for a contest in Active status.", "code": 3008, "status": 412 } ] }
	503	`scheduleDate` parameter was excluded;	Error Response 503 Expand source { "status": 503 }