https://www.helprange.com/api/v2/data-rooms/{data_room_id}/folders/{folder_id}/deleteDeletes the room folder only – its documents stay in the room, at the top level. 409 when the room is frozen.
Plans: 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: rooms:write. Operation id: deleteDataRoomFolder
| Name | In | Type | Description |
|---|---|---|---|
data_room_id required | path | integer | Data room id (from List data rooms). (min 1) |
folder_id required | path | integer | Data room folder id (from List data room folders). (min 1) |
curl -X POST https://www.helprange.com/api/v2/data-rooms/10/folders/5/delete \
-H "X-API-Key: $HELPRANGE_API_KEY"const res = await fetch('https://www.helprange.com/api/v2/data-rooms/10/folders/5/delete', {
method: 'POST',
headers: {'X-API-Key': process.env.HELPRANGE_API_KEY},
});
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/data-rooms/10/folders/5/delete',
headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
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. |
409 | The data room is frozen, or the signed PDF is not ready yet. |
429 | A usage limit was reached – wait Retry-After seconds. |
{
"deleted": true,
"id": 5,
"data_room_id": 10,
"moved_to_top": 3
}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.