Leaderboards - Delete Leaderboard Entries

Service:

Progression

API Version:

241122

Deletes the specified entries from the given leaderboard.

POST https://titleId.playfabapi.com/Leaderboard/DeleteLeaderboardEntries

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Name	True	string	The name of the leaderboard.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EntityIds		string[]	The unique Ids of the entries to delete from the leaderboard.

Responses

Name	Type	Description
200 OK	EmptyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
DeleteLeaderboardEntriesRequest
EmptyResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

DeleteLeaderboardEntriesRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EntityIds	string[]	The unique Ids of the entries to delete from the leaderboard.
Name	string	The name of the leaderboard.

EmptyResponse

Error Codes

Name	Code
ApiNotEnabledForTitle	1520
LeaderboardNotFound	1567
LeaderboardUpdateNotAllowedWhileLinked	1578