Suspend a user

PUT 
/admin/users/:id/suspend.json

Suspend a user

Request

Path Parameters

id integerrequired

application/json

Body

suspend_until stringrequired
reason stringrequired
message stringrequired

Will send an email with this message when present

post_action stringrequired

Responses

200

response

application/json

Schema

Schema

suspension objectrequired
suspend_reason stringrequired
full_suspend_reason stringrequired
suspended_till stringrequired
suspended_at stringrequired
suspended_by objectrequired
id integerrequired
username stringrequired
name stringrequired
avatar_template stringrequired

Example (from schema)

{
  "suspension": {
    "suspend_reason": "string",
    "full_suspend_reason": "string",
    "suspended_till": "string",
    "suspended_at": "string",
    "suspended_by": {
      "id": 0,
      "username": "string",
      "name": "string",
      "avatar_template": "string"
    }
  }
}

Loading...