Ban user from a community

Request

Path Params

Body Params application/json

Example

{
    "ip": true,
    "message": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/communities//bans/' \
--header 'Content-Type: application/json' \
--data '{
    "ip": true,
    "message": "string"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "success": true,
    "ban": {
        "user": {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "objectType": "user",
            "username": "FunnyKitten",
            "slug": "funny-dog",
            "tier": "GUEST",
            "cursor": 0,
            "legacyAvatar": "https://tanggle.io",
            "isSuperuser": true
        },
        "connections": {
            "twitch": {
                "id": "string",
                "username": "string"
            },
            "discord": {
                "id": "string",
                "username": "string"
            },
            "ip": true
        },
        "message": "string",
        "createdBy": {
            "objectType": "community_member",
            "user": {
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "objectType": "user",
                "username": "FunnyKitten",
                "slug": "funny-dog",
                "tier": "GUEST",
                "cursor": 0,
                "legacyAvatar": "https://tanggle.io",
                "isSuperuser": true
            },
            "role": "member",
            "roleManagement": "manual",
            "connections": {
                "twitch": {
                    "id": "string",
                    "username": "string"
                },
                "discord": {
                    "id": "string",
                    "username": "string"
                }
            },
            "createdAt": "2019-08-24T14:15:22.123Z"
        },
        "createdAt": "2019-08-24T14:15:22.123Z"
    }
}