Skip to main content
PUT
/
resellers
/
custodians
/
{custodianId}
/
suspend
Suspend a sub-custodian
curl --request PUT \
  --url https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend', 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/resellers/custodians/{custodianId}/suspend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.portalhq.io/api/v3/resellers/custodians/{custodianId}/suspend")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "custodian_123",
  "name": "Acme Payments",
  "slug": "acme-payments",
  "billingStatus": "SUSPENDED",
  "isReseller": false,
  "resellerParentId": "reseller_custodian_123",
  "sessionTokensEnabled": true,
  "createdAt": "2026-07-08T18:00:00.000Z",
  "updatedAt": "2026-07-08T18:15:00.000Z"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

Reseller API key created in the Portal dashboard.

Path Parameters

custodianId
string
required

The ID of a sub-custodian owned by the authenticated reseller.

Response

Sub-custodian suspended successfully

id
string
name
string
slug
string
billingStatus
enum<string>
Available options:
ACTIVE,
HACKATHON,
INACTIVE,
INTERNAL,
SUSPENDED,
TRIAL
isReseller
boolean
resellerParentId
string | null
sessionTokensEnabled
boolean
createdAt
string<date-time>
updatedAt
string<date-time>
billingPlan
object
environments
object[]
users
object[]
apiKeys
object[]