Skip to main content
POST
Ban Users

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

The existence of each user will not be verified. When banning by IP, multiple players may be affected, so use this feature with caution. Returns information about the new bans.

The existence of each user will not be verified. When banning by IP, multiple players may be affected, so use this feature with caution. Returns information about the new bans.

Bans
object[]
required

List of ban requests to be applied. Maximum 100.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026