DeleteLeaderboards

{
    "packetId": 1,
    "messages": [
        {
            "service": "leaderboard",
            "operation": "DELETE_LEADERBOARDS",
            "data": {
                "leaderboardIds": [
                    "leaderboardId1",
                    "leaderboardId2"
                ]
            }
        }
    ]
}

Deletes the specified leaderboards from brainCloud server.

Service	Operation
leaderboard	DELETE_LEADERBOARDS

Method Parameters

Parameter	Description
leaderboardIds	A collection of leaderboards to delete.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Objective-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var leaderboardIds = [
    "1st-leaderboard-id",
    "2nd-leaderboard-id"
];
var leaderboardProxy = bridge.getLeaderboardServiceProxy();

var postResult = leaderboardProxy.deleteLeaderboards(leaderboardIds);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "leaderboard",
    "operation": "DELETE_LEADERBOARDS",
    "data": {
        "leaderboardIds": [
            "1st-leaderboard-id",
            "2nd-leaderboard-id"
        ]
    }
}

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "status": 200,
            "data": {
                "deletedLeaderboardCount": 2,
                "message": "2 record(s) deleted successfully."
            }
        }
    ]
}