Suspend User

This endpoint is used to suspend a user. A suspended user can be reactivated using the user reactivate endpoint.

Controlled Errors

Error CodeError Message
error_invalid_valueThe API user cannot suspend itself.
error_user_not_foundUser with the provided Id was not found.
error_user_error_updating_account_ownerThe account owner cannot be suspended.
error_user_not_updatedThe user update failed.

Any status codes returned that are not provided here are generic status codes that can be found here.

Path Params
string
required

The Id of the user to be suspended.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain