Documentation

UpdateCharacterStatistics

Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.

Request Details

Enable this option with the 'Allow Client to Post Player Statistics' option in PlayFab GameManager for your title. However, this is not best practice, as this data will no longer be safely controlled by the server. This operation is additive. Character Statistics not currently defined will be added, while those already defined will be updated with the given values. All other user statistics will remain unchanged. Character statistics are used by the character-leaderboard apis, and accessible for custom game-logic.

UpdateCharacterStatisticsRequest
Request Properties
CharacterId (required) String

Unique PlayFab assigned ID for a specific character owned by a user

CharacterStatistics Dict<String, int32>

Statistics to be updated with the provided values.

POST https://{{TitleID}}.playfabapi.com/Client/UpdateCharacterStatistics
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "CharacterId": "98765432",
  "CharacterStatistics": {
    "Headshots": 18,
    "Kills": 47
  }
}
        

Response Details

UpdateCharacterStatisticsResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SessionTicket

Possible Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
CharacterNotFound 1135
InvalidCharacterStatistics 1138