Update wallet

Updates the display label of an active wallet under its exact Config or Connection owner.

PATCH/v1/wallets/{walletId}Run in dashboard

Requires an API key with the wallets.manage action.

Path parameters

  • walletId · string · required · min length 1 · example privy_wallet_123

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

Headers

  • x-project-id · string · min length 1 · example prj_example

    Required for dashboard sessions. API keys use their assigned project.

  • Idempotency-Key · string

    Use a unique 1–255 printable ASCII key per operation. Reuse it with the same request on retries. An in-flight attempt returns 409; a changed request returns 422. Retry and recovery rules.

Request body

application/json · required

Update wallet request body.

  • label · string | null · max length 100 · example Treasury signer

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

Responses

  • 200 Wallet updated

    • data · object · required

      Created wallet response payload.

      • wallet · object · required

        Wallet details.

        • id · string · required · example cw_example

          Wallet record ID.

        • custodyConfigId · string · example cfg_example

          Owning custody configuration ID.

        • custodyConnectionId · string · example cconn_example

          Owning Custody Connection ID.

        • provider · string · one of local, fireblocks, privy, coinbase_cdp, para, turnkey, dfns, ibm_haven, anchorage, utila · example privy

          Wallet signing provider.

        • isRuntimeExecutionAllowed · boolean · required · example true

          Whether SDP currently permits attempting runtime execution through this wallet's owner. This is request-time admission, not Provider health or a success guarantee.

        • walletId · string · required · min length 1 · example privy_wallet_123

          Provider wallet ID.

        • publicKey · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          Base58-encoded Solana address.

        • label · string | null · required · example Root Signing Wallet

          Optional wallet label.

        • purpose · string | null · required · example root

          Optional wallet purpose.

        • status · string · required · one of active, inactive · example active

          Wallet status.

        • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          ISO 8601 timestamp.

        • balances · object[]

          Tracked token balances when requested and successfully observed. Omitted when the balance lookup is unavailable; an empty array is a successful zero-token result.

          • token · string · required · example USDC

            Tracked token symbol.

          • mint · string · required · min length 32 · max length 44 · example 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU

            Tracked token mint address.

          • amount · string · required · example 1250000

            Raw token amount as a string.

          • uiAmount · string · required · example 1.25

            Human-readable token balance.

          • decimals · integer · required · min 0 · example 6

            Token decimals.

          • usdPrice · number · example 1

            Resolved USD price per token when available.

          • usdValue · number · example 125.5

            Resolved USD value of this balance when pricing is available.

        One of:

        • Owned by a Managed config. · must include custodyConfigId · must not include custodyConnectionId

        • Owned by a Custody Connection. · must include custodyConnectionId · must not include custodyConfigId

    • meta · object · required

      Response metadata.

      • requestId · string · required · min length 1 · example req_example

        Request identifier for tracing.

      • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • 400 Bad Request

    • error · object · required

      Standard error payload.

      • code · string · required

        Machine-readable error code.

      • message · string · required

        Human-readable error message.

      • details · object

        Optional error details for debugging.

        • * · any

    • meta · object

      • requestId · string · min length 1 · example req_example

        Request identifier for tracing.

  • 401 Unauthorized

    Same fields as 400.

  • 403 Forbidden. Requires the wallets.manage action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

    Same fields as 400.

  • 404 Not Found

    Same fields as 400.

  • 409 Conflict

    Same fields as 400.

  • 422 Unprocessable Entity

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

Example request

curl -X PATCH 'https://api.solana.com/v1/wallets/privy_wallet_123' \
  -H "Authorization: Bearer $SDP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Treasury signer"
  }'

Example responses

{
  "data": {
    "wallet": {
      "id": "cw_example",
      "custodyConfigId": "cfg_example",
      "provider": "privy",
      "isRuntimeExecutionAllowed": true,
      "walletId": "privy_wallet_123",
      "publicKey": "So11111111111111111111111111111111111111112",
      "label": "Root Signing Wallet",
      "purpose": "root",
      "status": "active",
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Error responses use the standard error shape.

Is this page helpful?