Ban a user from a group

POST

/api/v1/groups/{groupId}/ban

curl --request POST \
  --url http://localhost:3001/api/v1/groups/example/ban \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example", "user_address": "example" }'

• Local development
• Production

Add a user to a group’s ban list. Distinct from the global RBAC ban — only affects rejoin/add for this group.

Authorizations

• BearerAuth

Parameters

Path Parameters

groupId

required

string

Group ID

Request Body^required

User to ban

Media typeapplication/json

object

reason

string

user_address

string

Example^generated

{
  "reason": "example",
  "user_address": "example"
}

Responses

200

Banned

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

403

Forbidden

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}