Documentation

UpdateBans

Updates information of a list of existing bans specified with Ban Ids.

Request Details

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.

UpdateBansRequest
Request Properties
Bans (required) List<UpdateBanRequest>

List of bans to be updated. Maximum 100.

POST https://{{TitleID}}.playfabapi.com/Admin/UpdateBans
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Bans": [
    {
      "BanId": "E0B5FF89542D413C",
      "Permanent": true,
      "Active": true
    },
    {
      "BanId": "EF43FF89542G1546",
      "Reason": "Royal pardon",
      "Expires": "2016-07-04T00:00:00Z"
    }
  ]
}
        

Response Details

UpdateBansResult
Result Properties
BanData List<BanInfo>

Information on the bans that were updated

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": true
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code