Account Management - Update Bans
Updates information of a list of existing bans specified with Ban Ids.
POST https://titleId.playfabapi.com/Admin/UpdateBansRequest 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 |
|---|---|---|---|
| Bans | True |
List of bans to be updated. Maximum 100. |
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 |
|
Ban |
Contains information for a ban. |
|
Update |
Represents a single update ban request. |
|
Update |
For each ban, only updates the values that are set. Leave any value to null for no change. If a ban could not be found, the rest are still applied. Returns information about applied updates only. |
|
Update |
|
|
User |
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 |
BanInfo
Contains information for a ban.
| Name | Type | Description |
|---|---|---|
| Active |
boolean |
The active state of this ban. Expired bans may still have this value set to true but they will have no effect. |
| BanId |
string |
The unique Ban Id associated with this ban. |
| Created |
string |
The time when this ban was applied. |
| Expires |
string |
The time when this ban expires. Permanent bans do not have expiration date. |
| IPAddress |
string |
The IP address on which the ban was applied. May affect multiple players. |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| Reason |
string |
The reason why this ban was applied. |
| UserFamilyType |
string |
The family type of the suer that is included in the ban. |
UpdateBanRequest
Represents a single update ban request.
| Name | Type | Description |
|---|---|---|
| Active |
boolean |
The updated active state for the ban. Null for no change. |
| BanId |
string |
The id of the ban to be updated. |
| Expires |
string |
The updated expiration date for the ban. Null for no change. |
| IPAddress |
string |
The updated IP address for the ban. Null for no change. |
| Permanent |
boolean |
Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. |
| Reason |
string |
The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. |
| UserFamilyType |
The updated family type of the user that should be included in the ban. Null for no change. |
UpdateBansRequest
For each ban, only updates the values that are set. Leave any value to null for no change. If a ban could not be found, the rest are still applied. Returns information about applied updates only.
| Name | Type | Description |
|---|---|---|
| Bans |
List of bans to be updated. Maximum 100. |
UpdateBansResult
| Name | Type | Description |
|---|---|---|
| BanData |
Ban |
Information on the bans that were updated |
UserFamilyType
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| Steam |
string |
|
| Xbox |
string |