Wallets & Addresses
Edit Address
Update the label, omnibus pool membership, or auto_refill gas setting for an existing Finrock deposit address. Only fields you pass are changed.
PATCH
MCP scope:
dac.funds (not available to AI connectors yet)
The Edit Address endpoint lets you update the metadata and configuration of an existing deposit address. You can rename the address label, change whether the address participates in the omnibus pool, or toggle automatic gas refilling from your Gas Tank. Only the fields you explicitly include in the request body are updated — omitting a field leaves it unchanged.
Body Parameters
The asset associated with the address you want to edit. Use the
id value from the Supported Assets list.The destination tag or memo associated with the address. Required for uniquely identifying addresses on tag-based blockchains (e.g. XRP, XLM). Pass an empty string for chains that do not use address tags.
A new human-readable label for the address. Omit this field to leave the existing label unchanged.
Set to
true to add the address to the omnibus pool, or false to make it isolated. This field is only updated when you explicitly pass true or false — omitting it leaves the current value intact.Set to
true to enable automatic gas refilling from the Gas Tank, or false to disable it. This field is only updated when you explicitly pass true or false — omitting it leaves the current value intact.Response
A successful request returns HTTP200 with the updated address object.
To change only the label, include
asset, address, address_tag, and label in the body. Omit omnibus and auto_refill entirely — sending those fields as null may produce unexpected behaviour.
