Docs
V2 APIUsers

Remove user from account

Removes the user from the current account. The user record itself, and their membership of any other account, are untouched. You cannot remove yourself, and only admins can remove an admin.

DELETE/api/v2/users/{user}

Removes the user from the current account. The user record itself, and their membership of any other account, are untouched. You cannot remove yourself, and only admins can remove an admin.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

user*string
Formatuuid

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty