Options




Parameter

Type

Description

Request
Response
GETPUTPOSTDELETEGETPUTPOSTDELETE
numberOfEntrants
ObjectMaximum and Minimum number of entrants
OptionalOptional
YesYesYes
products
Array [Object]A list of Product
YesYes
YesYesYes
ruleSets
Array [Object]A list of RuleSet
YesYes
YesYesYes
isPublicBooleanIs the event publicly exposed depending on the event model. Default is true.
YesYes
YesYesYes
autoStartBooleanTrue means that the event will auto start depending on the scheduledDates
YesYes
YesYesYes
autoStartIntervalIntegerThe interval in which the Auto Start is issued. The default is 1000
YesYes
YesYesYes
autoStopBooleanTrue means that the event will auto stop depending on the scheduledDates
YesYes
YesYesYes
autoStopIntervalIntegerThe interval in which the Auto Stop is issued. The default is 1000
YesYes
YesYesYes
scheduledDates
ObjectStartEndDate model. When the event is scheduled to start and end
OptionalOptional
YesYesYes
actualDates
ObjectStartEndDate model. The actual start and end time and date of the event.
OptionalOptional
YesYesYes
limitEntrantsTo
Array [String]

A list of strings

*Limit the the entrant that can compete in this competition to certain group membership


OptionalOptional
YesYesYes
includeEntrantsWhere
ObjectComplexFilters model
OptionalOptional
YesYesYes
optinRequiredForEntrants
BooleanIf True, members must Opt in before they can acquire points in the contest
Optional
Optional
YesYesYes
notification
ObjectA Notification model
OptionalOptional
YesYesYes
strategies
ObjectA Strategies model
OptionalOptional
YesYesYes