Skip to main content
POST
Create Leaderboard Definition

Authorizations

X-EntityToken
string
header
required

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

Body

application/json
Columns
object[]
required

Leaderboard columns describing the sort directions, cannot be changed after creation.

EntityType
string
required

The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use 'external' as the type.

Name
string
required

A name for the leaderboard, unique per title.

SizeLimit
number
required

Maximum number of entries on this leaderboard

VersionConfiguration
object
required

The version reset configuration for the leaderboard definition.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026