Rename a Counterparty
Changes a counterparty's label. The label is the only thing that can change: the coin, address and memo are what the counterparty is. To pay a different address, save a new counterparty.
Part of crypto v3, in beta. While crypto v3 counterparties are off for the account, this answers 404 feature_not_enabled.
An account-scoped key renames only its own account's counterparties; another account's reads as 404. A workspace-scoped key renames any counterparty of the workspace.
Replaces PUT /api/v2/crypto/beneficiaries/{id}.
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
/v3/crypto/counterparties/{counterparty_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
counterparty_id | string (wlt_…) | Required. The counterparty. |
Request Body Sample
{
"label": "Supplier payouts (EU)"
}
Request Body Schema
| Field | Type | Description |
|---|---|---|
label | string | Required. The new label, up to 255 characters; leading and trailing spaces are dropped. |
Response Sample
{
"id": "wlt_01k8z5q7r9s1t3v5w7x9y1z3a5",
"customer_id": "cst_01h455vb4pex5vsknk084sn02q",
"coin": "USDC",
"address": "0x8f3b2c1d0e9a7b6c5d4e3f2a1b0c9d8e7f6a5b4c",
"label": "Supplier payouts (EU)",
"network": "ERC20",
"reference": "supplier-17",
"status": "active",
"created_at": "2026-10-20T15:40:00Z",
"updated_at": "2026-10-20T17:05:12Z"
}
Response Schema
The renamed counterparty, with the fields of a List Counterparties row, without customer.
When the label changed, it also sends the crypto_beneficiary_updated webhook.
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | The body is not valid JSON, or counterparty_id is not a wlt_… id. |
400 | invalid_label | label is longer than 255 bytes (characters outside ASCII take more than one). |
400 | invalid_account_id | A workspace-scoped key sent an account_id query parameter (see Turning it on) that is not a cst_… id. |
401 | unauthorized | Missing or invalid signature. |
404 | feature_not_enabled | Crypto v3 counterparties are not enabled. See Turning it on. |
404 | counterparty_not_found | No such counterparty, it belongs to another account, it was deleted, or the id is a deposit wallet's. |
422 | Validation failed | label is missing, empty, or longer than 255 characters; details names it. |
Coming from v2
v2 (PUT /api/v2/crypto/beneficiaries/{id}) | v3 |
|---|---|
PUT; a body without label clears it | PATCH; label is required |
id (uuid) | counterparty_id (wlt_…) |
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:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
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!