Returning.AI
Light Mode
update leaderboard
DevelopingPUT
/leaderboards/{id}Request
Path Params
id
string
required
Example:
66b2ed98bbd4d2b8c29cc099
Body Params application/json
object {0}
Example
{
"enabled": true,
"duration": {
"start": "2024-04-21T16:00:00.000+00:00",
"end": "2024-06-21T16:00:00.000+00:00",
"noEndDate": false
},
"performanceDisplay": {
"showTop": {
"enabled": true,
"value": 3
},
"showPositive": {
"enabled": true
},
"showDummy": {
"enabled": true
}
},
"rankedUserRoles": {
"roles": [
"642e37ce28200b49f61327ca",
"642e37ce28200b49f6132123"
],
"users": [
"491238",
"940163"
]
},
"viewPermissionUserRoles": {
"roles": [
"642e37ce28200b49f61327ca",
"642e37ce28200b49f6132dl1"
],
"users": [
"710361",
"440927"
]
}
}
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
meta
object
required
success
boolean
required
message
string
required
devMessage
string
required
body
object
required
_id
string
required
serverId
string
required
name
string
required
description
string
required
image
string
required
createdAt
string
required
updatedAt
string
required
__v
integer
required
Example
{
"meta": {
"success": true,
"message": "Leaderboard has been updated successfully",
"devMessage": "Leaderboard has been updated successfully"
},
"body": {
"_id": "66a2807ffe1c8797121428ae",
"serverId": "669b462658695ff095d431af",
"name": "Genesiv Leaderboard",
"description": "This is the leaderboard for Test",
"image": "https://chartsnapshot.s3.us-east-2.amazonaws.com/apireturningai/tester/1721925752712-1088b0a1d76b6acb8e744f5d1108255.png",
"createdAt": "2024-07-25T16:42:39.531Z",
"updatedAt": "2024-07-25T16:43:42.166Z",
"__v": 0
}
}
Modified at a month ago