PUT

Update address

Update a receive address on a wallet

Path Params

coin string required

A cryptocurrency symbol or token ticker symbol
walletId string required

matches ^[0-9a-f]{32}$
addressOrId string required

Address or Id which will be used for information lookup

Query Params

dt string

For XRP addresses
memoId string

For XLM addresses

Body Params

object

label string nullable

New label which should apply to this address. The caller needs admin permissions for the associated wallet if the label already has a value. Otherwise view or spend permissions are fine because the label has not been set yet. This is due to the fact that customers use address labels to associate addresses with their customers.

Responses

200

Response Body

object

coin string required

A cryptocurrency symbol or token ticker symbol
wallet string required
chain number enum required

011011202130314041
index number required
id string

Platform public ID for an address

matches ^[0-9a-f]{32}$
address string

up to 250 characters
balance object
balance object
- balanceString string required
  
  String representation of the balance. Guaranteed to not lose precision.
- confirmedBalanceString string required
  
  The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
- spendableBalanceString string required
  
  The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
- updated string
  
  The last time a transaction affected the balance of this address
- balance number
- lockedBalanceString string
- reservedBalanceString string
- totalReceived number
  
  The total amount received on this address (in the chain's base unit)
- totalSent number
  
  The total amount sent from this address (in the chain's base unit)
- transferCount number
- tokens map of objects
  tokens object
  - <key> object
- nfts map of objects
  nfts object
  - <key> object
- unsupportedNfts map of objects
  unsupportedNfts object
  - <key> object
- type object
- metadata object
coinSpecific object

Properties specific to certain coin types
ONE OF
- AlgorandAddress
- AtomAddress
- AvaxPAddress
- UtxoAddress
- BitcoinCashAddress
- CasperAddress
- DotAddress
- EosAddress
- EthereumAddress
- Ethereum2Address
- FiatAddress
- HederaAddress
- OffchainAddressSubdocument
- SolAddress
- StacksAddress
- StellarAddress
- TestcoinAddress
- TezosAddress
- TronAddress
- XRPAddress
- TonAddress
No matching variants
- rootAddress string required
- trustedTokens array of objects
  trustedTokens object
  
  state string enum
  
  pendingactive
  
  limit string
  
  token string
- addressVersion number
- threshold number
- bitgoKey object
- bitgoPubKey string
- rootAddress string required
- memoId string required
- threshold number required
- addresses array of strings required
- redeemScript string
- witnessScript string
- format string enum
  
  cashaddrbase58
- redeemScript string
- witnessScript string
- accountHash string required
- rootAddress string required
- transferId string required
- rootAddress string required
- nonceTracker object required
  nonceTracker object
  
  lastReservedNonce number required
  
  lastExecutedNonce number required
  
  detectedMissingNonces array of objects required
  
  detectedMissingNonces object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  
  detecMissingNoncesData array of objects required
  
  detecMissingNoncesData object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
- rootAddress string required
- memoId string required
- creationFailure array of strings required
- forwarderVersion number required
- nonce number required
- feeAddress string required
- pendingChainInitialization boolean required
- pendingDeployment boolean required
- txCount number required
- updateTime string date required
- hopTxid string
- salt string
- usdtBug boolean
- isTss boolean
- isNonceLocked boolean
- nonceLockExpireTime string date
- previousLowBalanceEmailSentAt string date
- feeAddress string
- bankAccountId string
- faBankAccountId string
- bankAccount object
  bankAccount object
  
  accountNumber string required
  
  address1 string required
  
  name string required
  
  owner object required
  
  owner object
  
  name string required
  
  address1 string required
  
  address2 string
  
  address3 string
  
  idHash string required
  
  verificationState string required
  
  address2 string
  
  address3 string
  
  enterpriseId string
  
  id string
  
  routingNumber string
  
  shortCountryCode string
  
  swiftCode string
  
  type string
- baseAddress string required
- memoId string required
- <key> object
- rootAddress string required
- minimumFunding number required
- pendingChainInitialization boolean required
- trustedTokens array of objects required
  trustedTokens object
  
  state string enum
  
  pendingactive
  
  limit string
  
  token string
- nonceExpiresAt string date
- nonceTxRequestid string
- type string
- baseAddress string required
- memoId string required
- memoId string required
- rootAddress string required
- <key> object
- counter number required
- updateTime string date required
- txCount number required
- pendingChainInitialization boolean required
- pendingPublicKeyRevelation boolean required
- creationFailure array of strings required
- delegate string
- previousLowBalanceEmailSentAt string date
- rootPub string required
- nonceTracker object required
  nonceTracker object
  
  detectedMissingNonces array of objects required
  
  detectedMissingNonces object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  
  detectedMissingNoncesData array of objects required
  
  detectedMissingNoncesData object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
- addresses array of strings required
label string

A human-readable label for the address

up to 250 characters
lastNonce number

Defaults to -1
token string
proof string
signature string
lastConsolidatedTime string date
needsConsolidation boolean
tokenConsolidationState object
tokenAddress object

400

Bad Request

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

401

Unauthorized

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

403

Forbidden

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

curl --request PUT \ --url 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/address/addressOrId&dt=string&memoId=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"label":"Bob's Hot Wallet Address"}'

const url = 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/address/addressOrId&dt=string&memoId=string'; const options = { method: 'PUT', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"label":"Bob's Hot Wallet Address"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/coin/wallet/walletId/address/addressOrId&dt=string&memoId=string") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"label":"Bob's Hot Wallet Address"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('PUT', 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/address/addressOrId&dt=string&memoId=string', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"label":"Bob's Hot Wallet Address"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/coin/wallet/walletId/address/addressOrId&dt=string&memoId=string" payload = {,"label":"Bob's Hot Wallet Address"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.text)

{ "coin": "btc", "wallet": "string", "chain": 0, "index": 0, "id": "59cd72485007a239fb00282ed480da1f", "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS", "balance": { "balanceString": "500000", "confirmedBalanceString": "400000", "spendableBalanceString": "40000", "updated": "string", "balance": 50000, "lockedBalanceString": "string", "reservedBalanceString": "string", "totalReceived": 0, "totalSent": 0, "transferCount": 0, "tokens": { "key": "string" }, "nfts": { "key": "string" }, "unsupportedNfts": { "key": "string" }, "type": "string", "metadata": "string" }, "coinSpecific": { "rootAddress": "string", "trustedTokens": [ { "state": "pending", "limit": "string", "token": "string" } ], "addressVersion": 0, "threshold": 0, "bitgoKey": "string", "bitgoPubKey": "string" }, "label": "Bob's Hot Wallet Address", "lastNonce": -1, "token": "string", "proof": "string", "signature": "string", "lastConsolidatedTime": "string", "needsConsolidation": true, "tokenConsolidationState": "string", "tokenAddress": "string" }