Skip to main content

Rename Wallet

Changes the label of a node wallet. The label is only a display name; the wallet keeps its id and address. The owning node is read from the wallet, and that node must be your own node or below it.

Required permission: node:update

Request​

PATCH /v2/admin/wallets/{wallet_id}

Parameters​

NameTypeInDescription
wallet_idstringpathRequired. A node wallet's id

Headers​

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

Body​

FieldTypeRequiredDescription
namestringNoThe new label. An empty or missing value clears the label

Example​

curl --request PATCH \
--url '{{baseUrl}}/v2/admin/wallets/6a53f3dfad48accdb46eaf9e' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Safe-Main-Wallet"
}'

Response​

200 OK with an empty body. The new label shows on List Node Wallets as label.

Errors​

StatusCodeDescription
40010016wallet_id is not a valid id
40010001Wallet not found, it is not a node wallet, or its node no longer exists (node domain 2)
40310005The wallet's node is outside your part of the hierarchy (node domain 2)

See Errors for the error format and common codes.