Leaderboards - Update Leaderboard Entries
Adds or updates entries on the specified leaderboard.
POST https://titleId.playfabapi.com/Leaderboard/UpdateLeaderboardEntriesRequest 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 |
|---|---|---|---|
| LeaderboardName | 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.). |
|
| Entries |
The entries to add or update on the leaderboard. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Empty |
|
|
Leaderboard |
|
|
Update |
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
LeaderboardEntryUpdate
| Name | Type | Description |
|---|---|---|
| EntityId |
string |
The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. |
| Metadata |
string |
Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. Must be less than 50 UTF8 encoded characters. |
| Scores |
string[] |
The scores for the leaderboard. The number of values provided here must match the number of columns in the Leaderboard definition. |
UpdateLeaderboardEntriesRequest
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entries |
The entries to add or update on the leaderboard. |
|
| LeaderboardName |
string |
The name of the leaderboard. |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| LeaderboardColumnLengthMismatch | 1562 |
| LeaderboardNotFound | 1567 |
| LeaderboardUpdateNotAllowedWhileLinked | 1578 |