1. Leaderboards
Returning.AI
  • Getting Started
  • Authentication
    • Secure Auth
      GET
    • register
      POST
    • verify email
      POST
    • login
      POST
    • Secure Auth
      GET
  • Users
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Gamification Stats
      POST
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      POST
    • Upload User Avatar
      POST
  • Roles & Permissions
    • role list of server
      GET
    • create new role
      POST
    • update role
      PUT
    • delete role
      DELETE
    • get role list of user on a server
      GET
    • add role to a user on a server
      POST
    • remove role from a user on a server
      POST
  • Servers
    • create new server
    • get my servers
    • update server
  • Channels
  • Messaging
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload Image
  • User Data
    • Get Specific User Field
    • Update Custom User Field
    • Delete Custom User Field
    • Get all user field histories in a community
    • Get user field histories for a specific field
    • Get user field histories for a specific user
    • Get user field histories of specific user field and user
    • Create user field history for specific user
  • Gamification
    • get badges list
    • create new badge
    • update badge
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
    • Edit wheel information for each user
    • Edit wheel information for each user
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
    • Get redemption transaction status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
    • Get All Bulk Update
    • Check Bulk Update Status
    • Check Bulk Update Details
    • Bulk Update
    • Premium Currency Bulk Update
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • Channels
    • Iframe
    • channel list of server
    • get channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • Features
  • Community Analytics
    • Get Loyalty Overview
  • Partner API
    • Leaderboards
      • List leaderboards with pagination
        GET
      • Get a single leaderboard by ID
        GET
      • Create a new leaderboard
        POST
      • Update an existing leaderboard
        PATCH
      • Delete a leaderboard
        DELETE
    • Purchase History
      • Update purchase history redemption instructions or voucher details
    • Personalization Service
      • Appearance
        • Theme Color Form Update
        • Server Bot
        • Meta
        • Name & Uri
    • Store
      • Get store configuration
      • Update store configuration
    • Categories
      • List store categories
      • Create store category
      • Update store category
      • Delete store category
      • Get store category by ID
    • Products
      • List store products
      • Create store product
      • Update store product
      • Delete store product
      • Get store product by ID
  • Community
    • Create new community
  • Schemas
    • Sample Schemas
    • Schemas
    • Outgoing webhooks
    • Analysis
    • Pet
    • ValidationError
    • Purchased store item
    • UpdateAnalysisRequest
    • Category
    • NotFoundError
    • New message posted to channel
    • AppendDrawingsRequest
    • Tag
    • InternalServerError
    • User visits server
    • CreateAnalysisResponse
    • NotImplementedError
    • User join server
    • GetAnalysisResponse
    • CreateUserFieldHistoryResponse
    • ErrorResponse
    • UpdateAnalysisResponse
    • CreateUserFieldHistorySuccessResponse
    • AppendDrawingsResponse
    • UserFieldHistoryItem
    • AnalysisMetadata
    • GetUserFieldHistoriesResponse
    • Expiry
    • UserFieldHistoriesValidationError
    • Levels
    • UserFieldHistoriesMetaWithValidation
    • LevelEntry
    • UserFieldHistoriesMetaWithPagination
    • Drawing
    • GetUserFieldHistoriesSuccessResponse
    • HorizontalLineDrawing
    • CreateUserFieldResponse
    • LineDrawing
    • CreateUserFieldSuccessResponse
    • RectangleDrawing
    • DeleteUserFieldResponse
    • ParallelDrawing
    • DeleteUserFieldSuccessResponse
    • FibonacciRetracementDrawing
    • UserFieldCreator
    • Coordinate
    • GetUserFieldResponse
    • DrawingStyle
    • GetUserFieldSuccessResponse
    • AnalysisDetail
    • ValidationErrorItem
    • AnalysisSummary
    • GetUserFieldsMetaResponse
    • CreateAnalysisRequest
    • CreatorInfo
    • ListAnalysesResponse
    • UserFieldResponse
    • GetUserFieldsSuccessResponse
    • UpdateUserFieldResponse
    • UpdateUserFieldPayload
    • UpdateUserFieldSuccessResponse
    • MetaResponse
    • GetUserResponse
    • GetUserSuccessResponse
  1. Leaderboards

Delete a leaderboard

DELETE
/leaderboards/{leaderboardID}
Deletes a leaderboard for the API-key's community by leaderboard ID and returns the deleted leaderboard ID.
Use this when a partner integration needs to remove a custom leaderboard that should no longer appear in the ReturningAI UI.
Authentication:
Bearer API key in Authorization header
Required permission: leaderboard
Community is resolved from the API key token; do not pass communityID
Returns 401 if missing, invalid, or insufficient
Side effects:
Deletes the leaderboard in the resolved community
Publishes the delete:leaderboard command through the partner publisher path
Gamification service processes the command and removes the leaderboard configuration
Deleted leaderboard no longer appears in the custom leaderboard UI
Rate limits:
Standard API rate limits apply
Constraints:
leaderboardID must identify a leaderboard in the API-key's community
Returns 404 when the leaderboard does not exist or is not in the resolved community
This operation is destructive; use PATCH /leaderboards/{leaderboardID} if the leaderboard should remain available
Example — delete:
DELETE /leaderboards/507f1f77bcf86cd799439012
Related endpoints:
GET /leaderboards — list leaderboards
POST /leaderboards — create a leaderboard
GET /leaderboards/{leaderboardID} — read a single leaderboard
PATCH /leaderboards/{leaderboardID} — update a leaderboard

Request

Path Params

Header Params

Responses

🟢200OK
application/json
Leaderboard deleted successfully
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
🔴502Bad Gateway
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://api.returning.ai/v1/leaderboards/507f1f77bcf86cd799439012' \
--header 'Authorization: Bearer XXXXXX'
Response Response Example
200 - Success Example
{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Delete leaderboard success.",
    "data": "507f1f77bcf86cd799439012"
}
Modified at 2026-05-04 10:06:10
Previous
Update an existing leaderboard
Next
Update purchase history redemption instructions or voucher details
Built with