Sign in
wallet

Update a wallet. (admin access required)

Updates a wallet

patch/wallet

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/wallet
  • Auth: API key in header token

Request body

idstring required

The id of the wallet to update

newCollectionAddressstring nullable required

The new collection address to set for this wallet. Pass null to clear.

Example request

{
  "id": "unique_cuid_v2_of_entry_to_update",
  "newCollectionAddress": "collection_address"
}

Response

Wallet updated

status'success' required

Example response

{
  "status": "success",
  "data": {
    "walletVkey": "wallet_vkey",
    "note": "note",
    "PendingTransaction": null,
    "walletAddress": "wallet_address",
    "collectionAddress": "collection_address",
    "LowBalanceSummary": {
      "isLow": true,
      "lowRuleCount": 1,
      "lastCheckedAt": "1970-01-20T20:00:36.260Z"
    },
    "LowBalanceRules": [
      {
        "id": "low_balance_rule_id",
        "assetUnit": "lovelace",
        "thresholdAmount": "5000000",
        "enabled": true,
        "topupEnabled": true,
        "topupAmount": "10000000",
        "status": "Low",
        "lastKnownAmount": "4200000",
        "lastCheckedAt": "1970-01-20T20:00:36.260Z",
        "lastAlertedAt": "1970-01-20T20:00:36.260Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.