Skip to main content
POST
Delete Character From User

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

This function will delete the specified character from the list allowed by the user, and will also delete any inventory or VC currently held by that character. It will NOT delete any statistics associated for this character, in order to preserve leaderboard integrity.

This function will delete the specified character from the list allowed by the user, and will also delete any inventory or VC currently held by that character. It will NOT delete any statistics associated for this character, in order to preserve leaderboard integrity.

CharacterId
string
required

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

PlayFabId
string
required

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

SaveCharacterInventory
boolean
required

If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those items.

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
Example:
Last modified on October 1, 2026