Skip to content

Remove a member

Remove an organization member or cancel their pending invitation. Their Computers transfer to the organization by default, or to the selected member or team. Shares are cleared unless keep_shares: true retains eligible shares. Transfer billing ownership before removing the billing owner.

Parameters

#
userstringRequired
Member email address or user ID, or pending invitation email address to cancel.
transfer_computers_toobject
Set exactly one of its fields.
Show 3 attributesHide attributes
userstring
Member who receives the departing member's Computers, by email address or user ID. The organization receives them by default.
teamstring
Team that receives the departing member's Computers in place of the organization.
organizationboolean
Transfer the departing member's Computers to the organization. Default when no recipient is given.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
keep_sharesboolean
Keep shares the new owner is allowed to grant. Without it, existing shares are removed.

Returns

#
dataobjectAlways present
A removed membership.
Show 1 attributeHide attributes
removedbooleanAlways present
True after the membership was removed.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.