On this page

Set GUI Storage Account Description

API-v2gui_storage::set_account_description

Sets or replaces the description field for the specified account.

ParameterTypeRequiredDescription
account_idAccountIdAccount to update.
descriptionstringNew description (≤ 600 characters).

ParameterTypeDescription
resultstringReturns success when the description has been updated.

set_account_description

POST
gui_storage::set_account_description
{
  "mmrpc": "2.0",
  "method": "gui_storage::set_account_description",
  "params": {
    "account_id": {
      "type": "hd",
      "account_idx": 0
    },
    "description": "My hardware account"
  },
  "id": 17,
  "userpass": "RPC_UserP@SSW0RD"
}

ParameterTypeDescription
DescriptionTooLongstringProvided description exceeds maximum length.
NoSuchAccountstringThe specified account_id does not exist.
ErrorLoadingAccountstringStorage read error.
ErrorSavingAccountstringStorage write error.
InternalErrorstringUnhandled internal error.