HomeAPI ReferenceGuides
API Reference
Start typing to search…

Update an existing Leaderboard's Contest.

patch
https://api.ottolearn.io/v1/rest/leaderboard()/contest()

Update the details of an existing Leaderboard's contest using a specific Leaderboard ID and Contest ID associated to it. Contest IDs associated to specific Leaderboard can be found using 'List Leaderboard Contest' API (/leaderboard({id}})/contest). Using this API call you can update the type of contest (draw or mostPoints), max winners, pointsRewardValue and contestRewardValue which are given to users on winning the contest and the contents. You can also add or update contest contents. Contest Results could not be created/updated directly using this API.

Path Params
int32
required

ID of a specific Leaderboard.

int32
required

ID of a specific Contest associated to the Leaderboard which id you enter in path parameters.

Body Params

The API endpoint expects an object with Contest properties, or Contest Contents properties to update.

string
enum
Allowed:
integer
≥ 1
integer
≥ 0
Defaults to 0
string | null
contents
array of objects
contents
Responses

Updated about 1 year ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 year ago