Skip to main content
PATCH
Deactivate a user

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string
required

Email of the user to deactivate.

Example:

"user@example.com"

tenantName
string | null

Tenant name override. Defaults to the caller's tenant when omitted.

Response

The user has been deactivated.

The response is of type DeactivateUserResponse · object.