Skip to main content
PATCH
/
custodians
/
me
/
clients
/
{clientId}
/
enable-eject
Enable wallet ejection
curl --request PATCH \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ejectableUntil": "2025-06-18T15:23:00.470Z",
  "walletId": "walletId"
}
'
import requests

url = "https://api.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject"

payload = {
"ejectableUntil": "2025-06-18T15:23:00.470Z",
"walletId": "walletId"
}
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({ejectableUntil: '2025-06-18T15:23:00.470Z', walletId: 'walletId'})
};

fetch('https://api.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject', 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.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject",
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([
'ejectableUntil' => '2025-06-18T15:23:00.470Z',
'walletId' => 'walletId'
]),
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.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject"

payload := strings.NewReader("{\n \"ejectableUntil\": \"2025-06-18T15:23:00.470Z\",\n \"walletId\": \"walletId\"\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.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ejectableUntil\": \"2025-06-18T15:23:00.470Z\",\n \"walletId\": \"walletId\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.portalhq.io/api/v3/custodians/me/clients/{clientId}/enable-eject")

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 \"ejectableUntil\": \"2025-06-18T15:23:00.470Z\",\n \"walletId\": \"walletId\"\n}"

response = http.request(request)
puts response.read_body
{
  "ejectableUntil": "2025-03-04T15:26:43.123Z"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

Portal API Key (Custodian API Key). Pass as a Bearer token in the Authorization header.

Path Parameters

clientId
string
required

The unique identifier of the client.

Body

application/json
walletId
string
required

The wallet ID of the wallet to eject.

ejectableUntil
string<date-time>

The time the wallet will no longer be ejectable. Must be at least 1 minute from now.

Response

Eject window enabled successfully

ejectableUntil
string<date-time>

The timestamp until which the wallet is ejectable.