Deactivate User

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Path Parameters

ParameterTypeDescriptionRequired
idstringUUID of the user.Yes

Response

Returns the deactivated user with deactivated_at set:

KeyTypeDescription
idstringUnique identifier of the user (UUID).
namestringDisplay name of the user.
emailstringEmail address of the user.
group_namesarrayNames of the groups the user belonged to.
deactivated_atdatetimeTimestamp when the user was deactivated.
created_atdatetimeTimestamp when the user was created.
🚧

Warning

Deactivation is immediate and cannot be reversed through the API. The user loses portal access instantly and receives an access revocation email.

Errors

StatusMessageDescription
404User not foundThe user does not exist, does not belong to this organization, or is already deactivated.
Path Params
string
required
Response

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