Skip to main content
PATCH
/
api
/
v1
/
wallets
/
{wallet_uuid}
Update wallet
import requests

url = "https://api.example.com/api/v1/wallets/{wallet_uuid}"

payload = {
    "name": "<string>",
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
{
  "result": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "wallet_type": "Custodial",
    "name": "<string>",
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cobo_wallet_id": "<string>",
    "status": "preparing",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "main_node_id": "<string>"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key
string | null

Path Parameters

wallet_uuid
string<uuid>
required

Body

application/json

Request payload for updating wallet metadata.

name
string | null

The new wallet name. Max 255 characters.

Required string length: 1 - 255
metadata
Metadata · object

Arbitrary key-value metadata to update on the wallet. Replaces the existing metadata.

Response

Successful Response

result
WalletRead · object
required

Wallet response payload.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.