Account Management - Delete Master Player Event Data

  • Reference
Service:
Admin
API Version:
240913

Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage

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

Request Header

Name Required Type Description
X-SecretKey True

string

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

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

DeleteMasterPlayerEventDataResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
DeleteMasterPlayerEventDataRequest

Deletes any PlayStream or telemetry event associated with the player from PlayFab. Note, this API queues the data for asynchronous deletion. It may take some time before the data is deleted.
DeleteMasterPlayerEventDataResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

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

DeleteMasterPlayerEventDataRequest

Deletes any PlayStream or telemetry event associated with the player from PlayFab. Note, this API queues the data for asynchronous deletion. It may take some time before the data is deleted.

Name Type Description
PlayFabId

string

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

DeleteMasterPlayerEventDataResult