Leaderboards - Update Leaderboard Definition

Service:

Progression

API Version:

250214

Updates a leaderboard definition.

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

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 update the definition for.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
SizeLimit		number	Maximum number of entries on this leaderboard
VersionConfiguration		VersionConfiguration	The version reset configuration for the leaderboard definition.

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
ResetInterval
UpdateLeaderboardDefinitionRequest
VersionConfiguration

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

ResetInterval

Name	Type	Description
Day	string
Hour	string
Manual	string
Month	string
Week	string

UpdateLeaderboardDefinitionRequest

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 update the definition for.
SizeLimit	number	Maximum number of entries on this leaderboard
VersionConfiguration	VersionConfiguration	The version reset configuration for the leaderboard definition.

VersionConfiguration

Name	Type	Description
MaxQueryableVersions	number	The maximum number of versions of this leaderboard/statistic that can be queried.
ResetInterval	ResetInterval	Reset interval that statistics or leaderboards will reset on. When using Manual intervalthe reset can only be increased by calling the Increase version API. When using Hour interval the resetwill occur at the start of the next hour UTC time. When using Day interval the reset will occur at thestart of the next day in UTC time. When using the Week interval the reset will occur at the start ofthe next Monday in UTC time. When using Month interval the reset will occur at the start of the nextmonth in UTC time.

Error Codes

Name	Code
LeaderboardSizeLimitExceeded	1575
MaxQueryableVersionsValueNotAllowedForTier	1591
ResetIntervalCannotBeModified	1598