Deactivate User

Allowed Scopes: experimental:user:manage

Deactivate (offboard) a user from the company the token resolves to. Only admins and account owners can perform this operation. Scoped to that company: the user's membership, roles and delegations for the company are removed, cards/subscriptions are handled downstream, and the user is fully removed only if this was their last company. Cannot deactivate an organisation or account owner, or a user with pending transfers.

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

ID of the user to deactivate.

Headers
string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

Responses

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