Delete Scores

Deletes scores either by specific score ID, or scores by a player ID.

All parameters in the request must be posted. Make all requests to the following URL:

https://leaderboards.construct.net/deletescores.json

Authenticating The Request

A secret must be passed in this request. This end point should not be called client side ever as it would expose the secret key.

secret string: If the game the leaderboard is associated with has a secret key, this must be provided or the request will be rejected.
Secret keys must never be exposed to clients.

leaderboardID guid Required: The ID of the leaderboard you want to post this score to
playerID guid: The ID of the player you want to delete scores for. The scores will be deleted in a random order. A playerID or scoreID must be provided in the request. Refer to the authentication service for how to retrieve this ID.
scoreID guid: The ID of the score to delete. A scoreID or playerID must be provided in the request.

Unsuccessful responses always return 4xx HTTP status codes.

{
  "success":false,
  "errorMessage":"timestamp is required parameter.",
  "shouldRetry":false
}

success bool: If the request was successful or not. For request failures, this will always be false.
errorMessage string: An short message explaining why the request was denied.
This should probably not be shown to clients.
shouldRetry bool: If true, this means the request is valid but it couldn't be processed at this current time - usually due to rate limits.
If this value returns as true, it's recommended to wait a few seconds then re-attempt the request. When re-attempting requests, make sure you regenerate the timestamp and hash parameters if no secret is being used.

Successful responses always return the HTTP 200 status code.

{
  "success": true,
  "scoresDeleted": 500,
  "mightHaveMore": true
}

success bool: If the request was successful or not. For request successes, this will always be true.
scoresDeleted int32: The number of scores deleted. This can range from 0 to 500. No more than 500 scores can be deleted in any one request.
mightHaveMore bool: If the scores deleted is the maximum allowed to be deleted in one request, this value will show as true indicating that there may be more scores to delete in this request.