Admin

Suspend a user

PUT

https://discourse.example.com/admin/users/{id}/suspend.json

Suspend a user

curl -X PUT 'https://discourse.example.com/admin/users/0/suspend.json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "suspend_until": "2121-02-22",
  "reason": "string",
  "message": "string",
  "post_action": "delete"
}'

const body = `{
  "suspend_until": "2121-02-22",
  "reason": "string",
  "message": "string",
  "post_action": "delete"
}`;

const response = await fetch('https://discourse.example.com/admin/users/0/suspend.json', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "suspend_until": "2121-02-22",
  "reason": "string",
  "message": "string",
  "post_action": "delete"
}'''

response = requests.put(
    'https://discourse.example.com/admin/users/0/suspend.json',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "suspend_until": "2121-02-22",
  "reason": "string",
  "message": "string",
  "post_action": "delete"
}

200

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

Body

application/json

suspend_untilstringrequired

Example

2121-02-22

reasonstringrequired

messagestring

Will send an email with this message when present

post_actionstring

Example

delete

Parameters

idintegerrequiredpath

Response

200OKany

response

Response fields application/json

suspensionobjectrequired

Show child attributes

suspend_reasonstringrequired

full_suspend_reasonstringrequired

suspended_tillstringrequired

suspended_atstringrequired

suspended_byobjectrequired

Show child attributes

idintegerrequired

usernamestringrequired

namestringrequired

avatar_templatestringrequired

Docs by Sourcey