Documentation

DeleteMasterPlayerAccount

Removes a master player account entirely from all titles and deletes all associated data

Request Details

Deletes all data associated with the master player account, including data from all titles the player has played, such as statistics, custom data, inventory, purchases, virtual currency balances, characters, group memberships, publisher data, credential data, account linkages, friends list and PlayStream event history. Removes the player from all leaderboards and player search indexes. Note, this API queues the player for deletion and returns a receipt immediately. Record the receipt ID for future reference. It may take some time before all player data is fully deleted. Upon completion of the deletion, an email will be sent to the notification email address configured for the title confirming the deletion. 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. It is highly recommended to know the impact of the deletion by calling GetPlayedTitleList, before calling this API.

DeleteMasterPlayerAccountRequest
Request Properties
MetaData String

Developer created string to identify a user without PlayFab ID

PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Admin/DeleteMasterPlayerAccount
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "A68C908B66C23C5",
  "MetaData": "Identifying info"
}
        

Response Details

DeleteMasterPlayerAccountResult
Result Properties
JobReceiptId String

A notification email with this job receipt Id will be sent to the title notification email address when deletion is complete.

TitleIds List<String>

List of titles from which the player's data will be deleted.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "JobReceiptId": "A101202A2CD049A0A93C9531DFB37DE8",
    "TitleIds": [
      "A248",
      "19B0"
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
AccountDeleted 1322
AccountNotFound 1001