Skip to main content
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.

​
Request

​
string
required
Your Finrock API key.
​
string
required
Your JWT bearer token in the format Bearer {JWT}.
​
string
required
The asset associated with the address you want to edit. Use the asset_name value from the Supported Assets list.
​
string
required
The blockchain address string you want to update.
​
string
required
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.
​
string
A new human-readable label for the address. Omit this field to leave the existing label unchanged.
​
boolean
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.
​
boolean
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.

​
Example Request

cURL

​
Response

A successful request returns HTTP 200 with the updated address object.
​
string
The blockchain address that was updated.
​
string
The destination tag or memo for the address.
​
string
The updated label for the address.
​
boolean
The current omnibus pool membership status after the update.
​
boolean
The current auto-refill status after the update.
Sample 200 Response
​
object
Returned when the x-api-key or Authorization header is missing or invalid.
Sample 401 Response
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.