Sign in
Wallets

Update wallet

Updates editable wallet metadata such as the display label.

patch/v1/wallets/{walletId}

Path parameters

walletIdstring required

Provider wallet ID — the walletId field returned by GET /v1/wallets.

Example:privy_wallet_123

Provider wallet ID — the walletId field returned by GET /v1/wallets.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

labelstring nullable

Optional wallet label. Set to null to clear the label.

Example request

{
  "label": "Treasury signer"
}

Response

Wallet updated

Example response

{
  "data": {
    "wallet": {
      "id": "cw_example",
      "custodyConfigId": "cfg_example",
      "provider": "privy",
      "isDefaultProvider": true,
      "walletId": "privy_wallet_123",
      "publicKey": "So11111111111111111111111111111111111111112",
      "label": "Root Signing Wallet",
      "purpose": "root",
      "status": "active",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "balances": [
        {
          "token": "USDC",
          "mint": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
          "amount": "1250000",
          "uiAmount": "1.25",
          "decimals": 6,
          "usdPrice": 1,
          "usdValue": 125.5
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes