HEhel
Withdrawals

Update a Withdrawal Config

Changed on

Updates an existing withdrawal configuration. Requires an API key with the WITHDRAWS_UPDATE permission.

patch/v1/withdrawal-configs/{withdrawalConfigId}/api-key

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key
  • Auth
    HTTP bearer

Path parameters

withdrawalConfigIdstring required

The withdrawal config ID.

Query parameters

apiKeystring required

Your API key, which can be generated from the Helio Dashboard settings page.

Request body

namestring
currencyIdsstring[]
disabledboolean
disabledBlockchainSymbolsstring[]
enabledFeaturesstring[]

Optional feature flags. iron enables Iron.xyz auto off-ramp.

themeIdstring

Optional ID of a saved theme to apply to this withdrawal config's hosted pages.

Response

Withdrawal config updated successfully.

idstring

The withdrawal config ID (withdrawalConfigId).

namestring
platformstring
disabledboolean
disabledBlockchainSymbolsstring[]
enabledFeaturesstring[]
createdAtstring date-time
updatedAtstring date-time

Changes