Delete a leaderboard
DELETE
/leaderboards/{leaderboardID}
What this endpoint does
INFO
leaderboard, call GET /v1/leaderboards, then use an id from that list.Quick start
PATCH or DELETE only after a disposable board exists. Do not patch prize/reset on a live community from docs.Authentication and permission
leaderboard.Complete examples
AUTH_PERMISSION_REQUIRED body as the list page when leaderboard is missing.message is Read leaderboard success. data is one board object with the same fields as a list row (_id, name, slug, rankBy, displayedFields, widget, and the rest).{
"meta": { "status": "success", "statusCode": 200 },
"message": "Read leaderboard success.",
"data": {
"_id": "<leaderboardID>",
"name": "Example board",
"slug": "example-board",
"rankBy": "Messages Sent"
}
}Success and readback
200 is the readback for PATCH. After DELETE, the id should disappear from the list.Errors and recovery
| Status | When | Recovery |
|---|---|---|
403 leaderboard | Key lacks permission | Grant leaderboard. |
404 | Path without /v1 | Prefix /v1. |
401 | Missing or invalid token | Replace the key. |
Retry safety
WARNING
Gotchas
{leaderboardID} is not a user id.Next steps
Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://adss-production.returning.ai/apis/partner/leaderboards/65f1b2c3d4e5f67890123456' \
--header 'Authorization: Bearer XXXXXX'Response Response Example
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Delete leaderboard success.",
"data": {
"_id": "507f1f77bcf86cd799439012",
"deleted": true
}
}Modified at 2026-08-19 18:40:29