SysDeleteLeaderboardConfig

Delete a leaderboard config, with support for tournament leaderboards. Note that a leaderboard configured as a tournament template-only cannot be deleted if any division set configuration is referencing it.

Service	Operation
leaderboard	SYS_DELETE_LEADERBOARD_CONFIG

Method Parameters

Parameter	Description
leaderboardId	The leaderboard to delete.
forceDelete	Flag indicates whether to force delete leaderboard even if it has a tournament in progress or if it is an ADHOC leaderboard with future scheduled tournament period(s).

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Objective-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var leaderboardId = "a-leaderboard-id";
var forceDelete = False;
var leaderboardProxy = bridge.getLeaderboardServiceProxy();

var postResult = leaderboardProxy.sysDeleteLeaderboardConfig(leaderboardId, forceDelete);

Raw

{
    "service":"leaderboard",
    "operation":"SYS_DELETE_LEADERBOARD_CONFIG",
    "data":{
        "leaderboardId":"a-leaderboard-id",
        "forceDelete":false
    }
}

JSON Response

{
    "status": 200,
    "data": {}
}