Ctrl+K

Update v1 comment

post/api/v1/wallettx/{txId}/comment

Update the comment of a v1 wallet transfer Requirements:

  • Transaction must be generated from a BitGo wallet

Path Parameters

  • txIdstringRequired
    The on-chain transaction id
    Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26

Request Body

comment string
The new comment for the transfer.

200 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletId string
id of the wallet (first receive address)
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
toAddress string
Receive address for this transaction
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
transactionId string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
date string <date-time>
Example: {}
createdDate string <date-time>
Example: {}
confirmedDate string <date-time>
Example: {}
amount integer
The total value in base units (satoshis)
btcusd number
The US Dollar value of the amount at the point of creation
state string
The state of the transfer. Includes the following: - `confirmed`: The transfer is confirmed on chain. - `failed`: BitGo failed to confirm the transfer on chain. You must retry the transaction. - `initialized`: The initial state when creating a transfer. - `pendingApproval`: The transfer requires admin approval to proceed. - `rejected`: The transfer was rejected by an admin. - `removed`: A network re-org occurred, causing the confirmed transfer to be removed from the blockchain. - `replaced`: The transfer was stuck due to having a low fee and was replaced by a new transfer with a higher fee. - `signed`: The transfer was approved by an admin (if required) and then signed by BitGo. - `unconfirmed`: The signed transaction was sent to the network, and is pending on-chain validation.
Allowed values: confirmed failed initialized pendingApproval rejected removed replaced signed unconfirmed
Example: confirmed
instant boolean
BitGo instant transaction
instantFee integer
BitGo instant fee in base units (satoshis)
bitgoFee integer
BitGo fee in base units (satoshis)
fee integer
comment string
creator string
history array[object]
date string <date-time>
The date of this history object
user string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
action string
Allowed values: created signed unconfirmed confirmed approved commented removed failed rejected
comment string
If this history object is of action "commented", this is the comment from the user
pendingApproval string
pending approval id, if exists

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code

401 Response

error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code