Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Suspend account

POST
/api/v1/instance/accounts/{user_id}/suspend
curl --request POST \
  --url https://example.com/api/v1/instance/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suspend \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "confirmation": "example" }'

No sign-in and every session ended, on the whole deployment; the account’s email typed to confirm. Never yourself, never the last instance administrator.

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
InstanceAccountSuspendRequest
object
confirmation
required
Confirmation
string
>= 1 characters <= 255 characters

Example generated

{
  "confirmation": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstanceAccountRead
object
created_at
required
Created At
string format: date-time
email
required
Email
string
full_name
required
Any of:
string
is_instance_admin
required
Is Instance Admin
boolean
last_login_at
required
Any of:
string format: date-time
organizations
required
Organizations
Array<object>
InstanceAccountOrganizationRead
object
disabled
required
Disabled
boolean
id
required
Id
string format: uuid
name
required
Name
string
roles
required
Roles
Array<string>
sole_program_manager
required
Sole Program Manager
boolean
suspended_at
required
Any of:
string format: date-time
user_id
required
User Id
string format: uuid

Example generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "email": "example",
  "full_name": "example",
  "is_instance_admin": true,
  "last_login_at": "2026-04-15T12:00:00Z",
  "organizations": [
    {
      "disabled": true,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "roles": [
        "example"
      ],
      "sole_program_manager": true
    }
  ],
  "suspended_at": "2026-04-15T12:00:00Z",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}