Documentation

DeletePlayer

Removes a user's player account from a title and deletes all associated data

Request Details

Deletes all data associated with the player, including statistics, custom data, inventory, purchases, virtual currency balances, characters and shared group memberships. Removes the player from all leaderboards and player search indexes. Does not delete PlayStream event history associated with the player. Does not delete the publisher user account that created the player in the title nor associated data such as username, password, email address, account linkages, or friends list. Note, this API queues the player for deletion and returns immediately. It may take several minutes or more before all player data is fully deleted. Until the player data is fully deleted, attempts to recreate the player with the same user account in the same title will fail with the 'AccountDeleted' error. This API must be enabled for use as an option in the game manager website. It is disabled by default.

DeletePlayerRequest
Request Properties
PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Server/DeletePlayer
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "A68C908B66C23C5"
}
        

Response Details

DeletePlayerResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
AccountDeleted 1322
AccountNotFound 1001
APINotEnabledForGameServerAccess 1194