Characters - Update Character Statistics

Updates the values of the specified title-specific statistics for the specific character

POST https://titleId.playfabapi.com/Server/UpdateCharacterStatistics

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
CharacterId True

string

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

PlayFabId True

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CharacterStatistics

object

Statistics to be updated with the provided values.

CustomTags

object

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

Responses

Name Type Description
200 OK

UpdateCharacterStatisticsResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

UpdateCharacterStatisticsRequest

Character statistics are similar to user statistics in that they are numeric values which may only be updated by a server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.

UpdateCharacterStatisticsResult

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

UpdateCharacterStatisticsRequest

Character statistics are similar to user statistics in that they are numeric values which may only be updated by a server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.

Name Type Description
CharacterId

string

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

CharacterStatistics

object

Statistics to be updated with the provided values.

CustomTags

object

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

PlayFabId

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

UpdateCharacterStatisticsResult

Error Codes

Name Code
CharacterNotFound 1135
InvalidCharacterStatistics 1138