Documentation

RevokeAllBansForUser

Revoke all active bans for a user.

Request Details

Setting the active state of all non-expired bans for a user to Inactive. Expired bans with an Active state will be ignored, however. Returns information about applied updates only.

RevokeAllBansForUserRequest
Request Properties
PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Server/RevokeAllBansForUser
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "1679AF5CD04BD838"
}
        

Response Details

RevokeAllBansForUserResult
Result Properties
BanData List<BanInfo>

Information on the bans that were revoked.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "BanData": [
      {
        "PlayFabId": "1679AF5CD04BD838",
        "BanId": "E0B5FF89542D413C",
        "IPAddress": "192.111.11.1",
        "Created": "2016-08-13T05:04:03Z",
        "Reason": "You cheated!",
        "Active": false
      },
      {
        "PlayFabId": "2329AF5CD04BF513",
        "BanId": "EF43FF89542G1546",
        "Created": "2016-05-13T05:04:03Z",
        "Expires": "2016-09-13T05:04:03Z",
        "Reason": "You used speed hack!",
        "Active": false
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
UserisNotValid 1030