Account Management - Export Master Player Data

Exports all associated data of a master player account

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

Request Body

Name Required Type Description
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

ExportMasterPlayerDataRequest

Exports 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. Note, this API queues the player for export and returns a receipt immediately. Record the receipt ID for future reference. It may take some time before the export is available for download. Upon completion of the export, an email containing the URL to download the export dump will be sent to the notification email address configured for the title.

ExportMasterPlayerDataResult

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

ExportMasterPlayerDataRequest

Exports 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. Note, this API queues the player for export and returns a receipt immediately. Record the receipt ID for future reference. It may take some time before the export is available for download. Upon completion of the export, an email containing the URL to download the export dump will be sent to the notification email address configured for the title.

Name Type Description
PlayFabId
  • string

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

ExportMasterPlayerDataResult

Name Type Description
JobReceiptId
  • string

An email with this job receipt Id containing the export download link will be sent to the title notification email address when the export is complete.

Error Codes

Name Code
AccountDeleted 1322
AccountNotFound 1001