Leaderboards - Unlink Leaderboard From Statistic

Service:

Progression

API Version:

241122

Unlinks a leaderboard definition from it's linked statistic definition.

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

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 definition to unlink.
StatisticName	True	string	The name of the statistic definition to unlink.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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
EmptyResponse
UnlinkLeaderboardFromStatisticRequest

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

EmptyResponse

UnlinkLeaderboardFromStatisticRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Name	string	The name of the leaderboard definition to unlink.
StatisticName	string	The name of the statistic definition to unlink.

Error Codes

Name	Code
LeaderboardNotFound	1567
NoLinkedStatisticToLeaderboard	1571