Atlas
Admin — Users

Ban user

Bans a user with optional reason and expiry.

POST
/api/v1/admin/users/{id}/ban

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/users/user_abc123/ban"
{
  "success": true
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}