Update a Withdrawal Config
curl --request PATCH \
--url https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currencyIds": [
"<string>"
],
"disabled": true,
"disabledBlockchainSymbols": [
"<string>"
],
"enabledFeatures": [
"iron"
],
"themeId": "<string>"
}
'import requests
url = "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key"
payload = {
"name": "<string>",
"currencyIds": ["<string>"],
"disabled": True,
"disabledBlockchainSymbols": ["<string>"],
"enabledFeatures": ["iron"],
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
currencyIds: ['<string>'],
disabled: true,
disabledBlockchainSymbols: ['<string>'],
enabledFeatures: ['iron'],
themeId: '<string>'
})
};
fetch('https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'currencyIds' => [
'<string>'
],
'disabled' => true,
'disabledBlockchainSymbols' => [
'<string>'
],
'enabledFeatures' => [
'iron'
],
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"platform": "<string>",
"disabled": true,
"disabledBlockchainSymbols": [
"<string>"
],
"enabledFeatures": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}WITHDRAWALS
Update a Withdrawal Config
Updates an existing withdrawal configuration. Requires an API key with the WITHDRAWS_UPDATE permission.
PATCH
/
v1
/
withdrawal-configs
/
{withdrawalConfigId}
/
api-key
Update a Withdrawal Config
curl --request PATCH \
--url https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currencyIds": [
"<string>"
],
"disabled": true,
"disabledBlockchainSymbols": [
"<string>"
],
"enabledFeatures": [
"iron"
],
"themeId": "<string>"
}
'import requests
url = "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key"
payload = {
"name": "<string>",
"currencyIds": ["<string>"],
"disabled": True,
"disabledBlockchainSymbols": ["<string>"],
"enabledFeatures": ["iron"],
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
currencyIds: ['<string>'],
disabled: true,
disabledBlockchainSymbols: ['<string>'],
enabledFeatures: ['iron'],
themeId: '<string>'
})
};
fetch('https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'currencyIds' => [
'<string>'
],
'disabled' => true,
'disabledBlockchainSymbols' => [
'<string>'
],
'enabledFeatures' => [
'iron'
],
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/withdrawal-configs/{withdrawalConfigId}/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"disabledBlockchainSymbols\": [\n \"<string>\"\n ],\n \"enabledFeatures\": [\n \"iron\"\n ],\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"platform": "<string>",
"disabled": true,
"disabledBlockchainSymbols": [
"<string>"
],
"enabledFeatures": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
Authentication using JWT token
Path Parameters
The withdrawal config ID.
Query Parameters
Your API key, which can be generated from the Helio Dashboard settings page.
Body
application/json
Maximum string length:
200Minimum array length:
1Optional feature flags. iron enables Iron.xyz auto off-ramp.
Available options:
iron Optional ID of a saved theme to apply to this withdrawal config's hosted pages.
