Characters - Reset Character Statistics

Service:

Admin

API Version:

241108

Completely removes all statistics for the specified character, for the current game

POST https://titleId.playfabapi.com/Admin/ResetCharacterStatistics

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.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	ResetCharacterStatisticsResult
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
ResetCharacterStatisticsRequest	Note that this action cannot be un-done. All statistics for this character will be deleted, removing the user from all leaderboards for the game.
ResetCharacterStatisticsResult

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

ResetCharacterStatisticsRequest

Note that this action cannot be un-done. All statistics for this character will be deleted, removing the user from all leaderboards for the game.

Name	Type	Description
CharacterId	string	Unique PlayFab assigned ID for a specific character owned by a user
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.

ResetCharacterStatisticsResult