Server administration

Set the suspended status of a particular user.

Sets the suspended status of a particular server-local user.

The user calling this endpoint MUST be a server admin. The client SHOULD check that the user is allowed to suspend other users at the GET /capabilities endpoint prior to using this endpoint.

In order to prevent user enumeration, servers MUST ensure that authorisation is checked prior to trying to do account lookups.

put/_matrix/client/v1/admin/suspend/{userId}

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v1/admin/suspend/:userId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring mx-user-id required

The user to change the suspended status of.

Request body

suspendedboolean required

Whether to suspend the target account.

Example request

{
  "suspended": true
}

Response

The action was successful.

suspendedboolean required

Whether the target account is suspended.

Example response

{
  "suspended": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.