Account Management - Delete Master Player Account

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

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

Request Body

Name Required Type Description
MetaData
  • string

Developer created string to identify a user without PlayFab ID

PlayFabId True
  • string

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

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

SecretKey

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

DeleteMasterPlayerAccountRequest

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.

DeleteMasterPlayerAccountResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

DeleteMasterPlayerAccountRequest

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.

Name Type Description
MetaData
  • string

Developer created string to identify a user without PlayFab ID

PlayFabId
  • string

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

DeleteMasterPlayerAccountResult

Name Type Description
JobReceiptId
  • string

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

TitleIds
  • string[]

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

Error Codes

Name Code
AccountDeleted 1322
AccountNotFound 1001
DataUpdateRateExceeded 1287