Documentation

DeleteUsers

Deletes custom data, all account linkages, and statistics.

Attention, this is a flagged API

obsolete
This API is obsolete as of 10-28-2018; use DeletePlayer instead. Obsolete methods will not exist in the latest SDK builds.

Please let us know if you find any issues or inconsistencies.

Request Details

Note that this action cannot be undone. It will unlink all accounts, reset any statistics and leaderboards, and clear out any stored custom data for the user. This API must be enabled for use as an option in the game manager website. It is disabled by default.

DeleteUsersRequest
Request Properties
PlayFabIds (required) List<String>

An array of unique PlayFab assigned ID of the user on whom the operation will be performed.

TitleId (required) String

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

POST https://{{TitleID}}.playfabapi.com/Server/DeleteUsers
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabIds": [
    "203945882"
  ],
  "TitleId": "aaa"
}
        

Response Details

DeleteUsersResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
APINotEnabledForGameServerAccess 1194
InvalidPublisherId 1126
InvalidTitleId 1004