Skip to main content

Rename a Deposit Wallet

Changes a deposit wallet's label. Nothing else about the wallet changes: its coin and address are fixed.

Beta

Part of crypto v3, in beta. This endpoint is open whether or not crypto v3 is enabled for the workspace.

An account-scoped key renames only its own account's wallets; another account's reads as 404. A workspace-scoped key renames any wallet of the workspace.

New in v3: v2 has no equivalent.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

PATCH

/v3/crypto/wallets/{wallet_id}

Path parameters​

ParameterTypeDescription
wallet_idstring (wlt_…)Required. The wallet.

Request Body Sample​

{
"label": "Savings"
}

Request Body Schema​

FieldTypeDescription
labelstringRequired. The new label: 1 to 255 characters once leading and trailing spaces are dropped.

Response Sample​

{
"id": "wlt_01k8y2c7d3e5f7g9h1j3k5m7n9",
"customer_id": "cst_01h455vb4pex5vsknk084sn02q",
"coin": "BTC",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"label": "Savings",
"status": "active",
"created_at": "2026-10-20T14:10:42Z",
"updated_at": "2026-10-20T15:22:09Z"
}

Response Schema​

The renamed wallet, with the fields of a List Deposit Wallets row, without customer.

Errors​

StatusmessageWhen
400failed to parse requestThe body is not valid JSON, or wallet_id is not a wlt_… id.
400invalid_labellabel is only spaces, or longer than 255 characters.
401unauthorizedMissing or invalid signature.
404wallet_not_foundNo such wallet, it belongs to another account, or the id is a counterparty's.
422Validation failedlabel is missing or empty; details names it.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!