https://www.helprange.com/api/v2/data-rooms/{data_room_id}/folders/moveMoves documents of the room into one of its folders, or to the room's top level (folder_id null or missing). Ids not in the room are listed in not_in_room. 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: moveDataRoomDocuments
| Name | In | Type | Description |
|---|---|---|---|
data_room_id required | path | integer | Data room id (from List data rooms). (min 1) |
Content types: application/json, application/x-www-form-urlencoded.
| Field | Type | Description |
|---|---|---|
room_link_ids | array of integer | Room documents (room_link_id from the room's documents or the index) … |
document_ids | array of integer | … and / or document ids. |
folder_id | integer or null | A folder of this room; null = the top level. |
curl -X POST https://www.helprange.com/api/v2/data-rooms/10/folders/move \
-H "X-API-Key: $HELPRANGE_API_KEY" \
-H 'Content-Type: application/json' \
--data-binary '{"room_link_ids": [910, 911], "folder_id": 5}'const res = await fetch('https://www.helprange.com/api/v2/data-rooms/10/folders/move', {
method: 'POST',
headers: {'X-API-Key': process.env.HELPRANGE_API_KEY, 'Content-Type': 'application/json'},
body: JSON.stringify({
"room_link_ids": [
910,
911
],
"folder_id": 5
}),
});
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/move',
headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
json={
"room_link_ids": [910, 911],
"folder_id": 5,
},
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. |
{
"moved": 2,
"data_room_id": 10,
"room_folder_id": 5,
"room_folder": "Financials",
"not_in_room": []
}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.