On this page

Enable GUI Storage Account

API-v2gui_storage::enable_account

Marks a specific account as the active (enabled) account within GUI storage. If the account doesn't yet exist you can create-and-enable it in a single call.

ParameterTypeRequiredDescription
policyEnableAccountPolicyEnumDetermines whether to enable an existing account or create-and-enable a new one.
account_idEnabledAccountIdRequired when policy = existing. Identifies the account to enable.
balance_usdstring (numeric)Optional initial USD balance when policy = new; defaults to 0.
descriptionstringOptional description (≤ 600 chars) for a new account.
namestringRequired when policy = new. Display name for the new account (≤ 255 chars).

ParameterTypeDescription
resultstringReturns success when the account is enabled.

Enable an existing Iguana account:

enable_account (existing)

POST
gui_storage::enable_account
{
  "mmrpc": "2.0",
  "method": "gui_storage::enable_account",
  "params": {
    "policy": "existing",
    "account_id": {
      "type": "iguana"
    }
  },
  "id": 1,
  "userpass": "RPC_UserP@SSW0RD"
}

Create and enable a new HD account:

enable_account (new)

POST
gui_storage::enable_account
{
  "mmrpc": "2.0",
  "method": "gui_storage::enable_account",
  "params": {
    "policy": "new",
    "account_id": {
      "type": "hd",
      "account_idx": 0
    },
    "name": "HD-0",
    "description": "Hardware HD account",
    "balance_usd": "0"
  },
  "id": 2,
  "userpass": "RPC_UserP@SSW0RD"
}

ParameterTypeDescription
NameTooLongstringProvided name exceeds maximum length.
DescriptionTooLongstringdescription exceeds maximum length.
AccountExistsAlreadystringAttempted to create an account that already exists (policy = new).
NoSuchAccountstringpolicy = existing but the given account_id was not found.
ErrorLoadingAccountstringStorage read error.
ErrorSavingAccountstringStorage write error.
InternalErrorstringUnhandled internal error.