Skip to content
Vouch Docs

Ban User

POST
/admin/users/{user_id}/ban
curl --request POST \
  --url https://example.com/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ban \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
BanIn
object
reason
required
Reason
string
>= 1 characters <= 1000 characters
Examplegenerated
{
  "reason": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AdminUserOut
object
ban_reason
required
Any of:
string
banned_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
has_profile
required
Has Profile
boolean
id
required
Id
string format: uuid
is_admin
required
Is Admin
boolean
matches
Matches
integer
0
open_pairs
Open Pairs
integer
0
phone_verified
required
Phone Verified
boolean
set_version
required
Any of:
integer
username
required
Any of:
string
Example
{
  "matches": 0,
  "open_pairs": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}