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

Bulk accounts

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

One action on several accounts (up to 100), each on its own: the ones refused are reported, not fatal. Suspending and deleting ask for the number of accounts typed to confirm.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InstanceAccountBulkRequest
object
action
required
Action
string
Allowed values: suspend reactivate end_sessions delete
confirmation
Confirmation
string
"" <= 10 characters
user_ids
required
User Ids
Array<string>
>= 1 items <= 100 items

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstanceAccountBulkRead
object
done
required
Done
integer
results
required
Results
Array<object>
InstanceAccountBulkOutcomeRead
object
code
required
Any of:
string
email
required
Any of:
string
message
required
Any of:
string
user_id
required
User Id
string format: uuid
skipped
required
Skipped
integer

Example generated

{
  "done": 1,
  "results": [
    {
      "code": "example",
      "email": "example",
      "message": "example",
      "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "skipped": 1
}

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"
    }
  ]
}