deleteSubOrganization()

Package: react-wallet-kit

Deletes the current sub-organization (sub-org) for the active session.

This function deletes the sub-organization associated with the current active session.
By default, the deletion will fail if any wallets associated with the sub-organization have not been exported.
If deleteWithoutExport is set to true, the sub-organization will be deleted even if its wallets have not been exported (potentially resulting in loss of access to those wallets).
Requires an active session; otherwise, an error is thrown.
Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params

object

Show params details

params.deleteWithoutExport

boolean

flag to delete the sub-organization without requiring all wallets to be exported first (defaults to false).

params.stampWith

StamperType

parameter to stamp the request with a specific stamper.

A successful response returns the following fields:

returns

TDeleteSubOrganizationResponse

required

A promise that resolves to a TDeleteSubOrganizationResponse object containing the result of the deletion.