Skip to main content

Rename User Wallet

Sets the label the wallet list shows for one of the user's wallets, which is how a user holding several wallets on one chain tells them apart. An empty label clears the name. Only the label changes: the address, chain and custody of a wallet are fixed.

The wallet must belong to this user. Another user's wallet (or a node's) is reported as not found.

Required permission: user:update

Request​

PATCH /v2/users/{user_id}/wallets/{wallet_id}

Parameters​

NameTypeInDescription
user_idstringpathRequired. User ID
wallet_idstringpathRequired. Wallet ID

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>
Content-TypeRequired. application/json

Body​

FieldTypeRequiredDescription
labelstringNoNew label. Empty or omitted clears the name

Example​

curl --request PATCH \
--url '{{baseUrl}}/v2/users/6a87455ad5f439809d488ac3/wallets/6a8754e187be1d0e22aa6d83' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"label": "Savings"
}'

Response​

Status Code: 200 OK, empty body.

Errors​

StatusCodeDescription
40010016wallet_id is not a valid id
40010001Wallet not found or not this user's (domain 1, message user not found)

See Errors for the error format and common codes.