Leaderboards - Increment Leaderboard Version

Service:

Progression

API Version:

241122

Increment a leaderboard version.

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

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 to increment the version for.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	IncrementLeaderboardVersionResponse
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
IncrementLeaderboardVersionRequest
IncrementLeaderboardVersionResponse

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

IncrementLeaderboardVersionRequest

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 to increment the version for.

IncrementLeaderboardVersionResponse

Name	Type	Description
Version	number	New Leaderboard version.

Error Codes

Name	Code
ConcurrentEditError	1133
LeaderboardDefinitionModificationNotAllowedWhileLinked	1576
LeaderboardNotFound	1567