Skip to main content
POST
Suspend a user

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Path Parameters

user
integer
required

User id.

Body

application/json
reason
string
required

Shown to the user.

Maximum string length: 500
suspended_by_user_id
integer
required

Staff user recorded as the actor.

duration
enum<string> | null

Omit or permanent for no expiry.

Available options:
1_hour,
6_hours,
1_day,
1_week,
1_month,
permanent,
null
suspend_services
boolean
default:false

Also suspend every active service of the user.

Response

Success.

data
object
required
meta
object
required
message
string

Human readable confirmation.