Characters - Delete Character From User
Deletes the specific character ID from the specified user.
POST https://titleId.playfabapi.com/Server/DeleteCharacterFromUserRequest 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 |
|---|---|---|---|
| CharacterId | True |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| PlayFabId | True |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| SaveCharacterInventory | True |
boolean |
If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those items. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Delete |
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. |
|
Delete |
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 |
DeleteCharacterFromUserRequest
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.
| Name | Type | Description |
|---|---|---|
| CharacterId |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| SaveCharacterInventory |
boolean |
If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those items. |
DeleteCharacterFromUserResult
Error Codes
| Name | Code |
|---|---|
| CharacterNotFound | 1135 |