https://www.helprange.com/api/v2/data-rooms/{data_room_id}/guests/removeTakes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
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: rooms:write. Operation id: removeDataRoomGuest
| Name | In | Type | Description |
|---|---|---|---|
data_room_id required | path | integer | Data room id (from List data rooms). (min 1) |
Header Idempotency-Key (optional, up to 255 characters): retry with the same key and body within 24 hours and you get the first response back (Idempotent-Replayed: true) – the request is not run twice. Another body: 422 idempotency_key_reused; still running: 409 idempotency_key_in_progress. More.
Content types: application/json, application/x-www-form-urlencoded.
| Field | Type | Description |
|---|---|---|
email | string | The guest's e-mail … |
guest_id | integer | … or id. (min 1) |
curl -X POST https://www.helprange.com/api/v2/data-rooms/10/guests/remove \
-H "X-API-Key: $HELPRANGE_API_KEY" \
-H 'Content-Type: application/json' \
--data-binary '{"email": "buyer@bidco.com"}'const res = await fetch('https://www.helprange.com/api/v2/data-rooms/10/guests/remove', {
method: 'POST',
headers: {'X-API-Key': process.env.HELPRANGE_API_KEY, 'Content-Type': 'application/json'},
body: JSON.stringify({
"email": "buyer@bidco.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/data-rooms/10/guests/remove',
headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
json={
"email": "buyer@bidco.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 (the Free plan) or this feature (e.g. NDA needs Max). |
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, the signed PDF is not ready yet, (webhooks) the team already has an endpoint / the endpoint is turned off, or (code idempotency_key_in_progress) a request with the same Idempotency-Key is still running – retry in a few seconds. |
422 | code idempotency_key_reused: this Idempotency-Key was already used in the last 24 hours with a different request (method, path or body). Use a new key for a new request. |
429 | A usage limit was reached – wait Retry-After seconds. |
{
"removed": true,
"id": 77,
"email": "buyer@bidco.com",
"data_room_id": 10
}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 and may e-mail people. 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.