v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Addresses

Update Address

This endpoint allows the client to update the status of a specific address within a wallet.

Body Parameters

Key	Required	Type	Description
isActive	false	boolean	The status state you want to set the address
name	false	string	The name of the address.
metadata	false	object	Additional metadata for the address. This will be part of any transaction tied to this.
showPrivateKey	false	boolean	If you want the address private key to be part of the response.
disableAutoSweep	false	boolean	Disable automatic sweeping of assets sent to the address into your master wallet.
enableGaslessWithdraw	false	boolean	Enable gasless transactions from this address.
privateKey	false	string	The private key associated with the address. Required for executing actions securely.

patch/v1/wallets/{walletId}/addresses/{addressId}

Request body

disableAutoSweepstring

enableGaslessWithdrawstring

isActivestring

metadatastring

namestring

showPrivateKeystring

Example request

{
  "disableAutoSweep": "OPTIONAL_BOOLEAN",
  "enableGaslessWithdraw": "OPTIONAL_BOOLEAN",
  "isActive": "OPTIONAL_BOOLEAN",
  "metadata": "OPTIONAL_METADATA",
  "name": "OPTIONAL_ADDRESS_NAME",
  "showPrivateKey": "OPTIONAL_BOOLEAN"
}

Response

200

messagestring

statusCodenumber

Example response

{
  "data": {
    "address": "0x3ec2a234DE95cC783291241B7070b19786b25d5b",
    "blockchain": {
      "createdAt": "2024-05-27T08:31:14.966Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "74733889-4ecd-403e-9840-94e87c043f24",
      "isActive": true,
      "isEvmCompatible": true,
      "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800080/crypto-assets/Base_Network_Logo_vqyh7r.png",
      "name": "base",
      "slug": "base",
      "symbol": "eth",
      "updatedAt": "2024-10-27T07:52:16.115Z"
    },
    "configurations": {
      "aml": {
        "message": "Address is not sanctioned",
        "provider": "ofac",
        "status": "success"
      },
      "disableAutoSweep": true,
      "enableGaslessWithdraw": true
    },
    "createdAt": "2024-11-11T16:48:19.682Z",
    "derivationPath": "m/44'/60'/0'/0/104",
    "id": "4982f18a-e9ec-43e8-b8a7-39de40f45e6f",
    "isActive": true,
    "name": "Customer 2",
    "network": "testnet",
    "type": "INTERNAL",
    "updatedAt": "2024-11-11T16:55:05.320Z"
  },
  "message": "Address updated successfully",
  "statusCode": 200
}