Documentation

DeleteCharacterFromUser

Deletes the specific character ID from the specified user.

Request Details

This function will delete the specified character from the list allowed by the user, and will also delete any inventory or VC currently held by that character. It will NOT delete any statistics associated for this character, in order to preserve leaderboard integrity.

DeleteCharacterFromUserRequest
Request Properties
CharacterId (required) String

Unique PlayFab assigned ID for a specific character owned by a user

PlayFabId (required) String

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

SaveCharacterInventory (required) Boolean

If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those items.

POST https://{{TitleID}}.playfabapi.com/Server/DeleteCharacterFromUser
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "12345",
  "CharacterId": "98765432",
  "SaveCharacterInventory": false
}
        

Response Details

DeleteCharacterFromUserResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {}
}

Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001
CharacterNotFound 1135