Update Wallet

The Update Wallet endpoint allows you to modify the properties of an existing wallet within a specific Signchain Vault. Currently, the only modifiable property is the wallet’s name.

Endpoint

PUT/api/v1/vaults/:vaultId/wallets/:address

Test Endpoint

Request Parameters

vaultId (path) - The unique identifier of the vault containing the wallet.
address (path) - The Ethereum address of the wallet to update.

Request Body

The request body should be in JSON format and include the following field:

name (string) - The new name for the wallet.

Example Request

curl -X PUT https://signchain.net/api/v1/vault/{vaultId}/wallets/{address} \
     -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "New Wallet Name"
         }'

Example Response

{
  "success": Request_Success_Status,
  "data": {
    "id": "<Your-Wallet-ID>",
    "account": "<Your-Account-ID>",
    "vault": "<Your-Vault-ID>",
    "name": "New Wallet Name",
    "address": "<Your-Unique-Wallet-Address>",
    "created": "<Current-Date-ISO>",
    "updated": "<Current-Date-ISO>",
    "expires": "<Wallet-Expiry-Date-ISO>"
  },
  "error": "<Error-Message>"
}

Response

The response returns the updated wallet object, containing:

success: A boolean true or false determining whether the update request was successful or not. If the update request was not successful, this value will be false and the error field will be populated.
error: A string error message, only sent if the success parameter is false.
id (string) - The unique identifier of the wallet within the vault.
account (string) - Your Signchain account ID.
vault (string) - Your vault's unique identifier.
name (string) - The descriptive name assigned to the wallet, as specified in the request body.
address (string) - The unique Ethereum address of the wallet.
created (string, ISO 8601 format) - The date and time when the wallet was created.
updated (string, ISO 8601 format) - The last updated date of the wallet, which will be when it was created.
expires (optional, string, ISO 8601 format) - If the wallet is set to expire, then this field will be included and is the date the wallet is marked for expiry and deletion, including all private key data associated with the wallet.

Using the Update Wallet endpoint, you can assign meaningful names to wallets, making it easier to organize and manage assets within your Signchain Vault.

Signchain Docs