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.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!