https://www.helprange.com/api/v2/folders/{folder_id}/buyers/removeTakes a buyer's access to a product folder away. Also works on Pro.
Plans: Pro, Max, Unlimited, Deal Room Pass, trial. Auth: Authorization: Bearer hr_live_… (team key), X-API-Key, Authorization: Api-Key <key> or an OAuth Bearer token. Scope: links:write. Operation id: revokeBuyerAccess
| Name | In | Type | Description |
|---|---|---|---|
folder_id required | path | integer | Folder id (from List folders). (min 1) |
Content types: application/json, application/x-www-form-urlencoded.
| Field | Type | Description |
|---|---|---|
email required | string | The buyer's e-mail. |
curl -X POST https://www.helprange.com/api/v2/folders/31/buyers/remove \
-H "X-API-Key: $HELPRANGE_API_KEY" \
-H 'Content-Type: application/json' \
--data-binary '{"email": "buyer@example.com"}'const res = await fetch('https://www.helprange.com/api/v2/folders/31/buyers/remove', {
method: 'POST',
headers: {'X-API-Key': process.env.HELPRANGE_API_KEY, 'Content-Type': 'application/json'},
body: JSON.stringify({
"email": "buyer@example.com"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${data.error || data.message || data.reason}`);
console.log(data);import os
import requests
r = requests.post(
'https://www.helprange.com/api/v2/folders/31/buyers/remove',
headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
json={
"email": "buyer@example.com",
},
timeout=60,
)
r.raise_for_status()
print(r.json())The samples read the key from the HELPRANGE_API_KEY environment variable.
| Status | Description |
|---|---|
200 | OK |
400 | Invalid input – the message says which parameter. |
401 | Missing or invalid API key / OAuth token. Team keys: code invalid_key, key_revoked, key_expired or key_owner_removed. |
402 | Your plan does not include the REST API (or this feature). |
403 | The team API key lacks the scope this endpoint needs. |
404 | Not found – or not yours (the API never says which). |
405 | Wrong HTTP method for this endpoint. |
429 | A usage limit was reached – wait Retry-After seconds. |
{
"id": "31-buyer@example.com",
"email": "buyer@example.com",
"folder_id": 31,
"folder": "Market report",
"removed": true
}Uses your real account. The request goes from your browser straight to www.helprange.com with your API key and acts as you – this POST changes data. The key stays in this page (in this tab's session storage only if you tick the box), is never put in a URL and is not sent to analytics. Do not paste a key on a shared computer.