Ban User

Bans a user from the specified chat. The bot must have ban permission.

POST /api/users/ban

Ban a user

cURL

curl --request POST \
  --url http://localhost:8080/api/users/ban \
  --header 'Authorization: Bearer <token>'

200

{
  "ok": true
}

Authorizations

BearerAuthCookieAuth

Authorization · string · header · required

API key with bmx_ prefix. Obtain via /api/auth/api-keys.

Query Parameters

bot_id · integer · required

chat_id · integer · required

user_id · integer · required

Response

200

application/json

User banned

ok · boolean

Example:

true