Documentation

RevokeBans

Revoke all active bans specified with BanId.

Request Details

Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only.

RevokeBansRequest
Request Properties
BanIds (required) List<String>

Ids of the bans to be revoked. Maximum 100.

POST https://{{TitleID}}.playfabapi.com/Server/RevokeBans
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "BanIds": [
    "E0B5FF89542D413C",
    "EF43FF89542G1546"
  ]
}
        

Response Details

RevokeBansResult
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