POST

v1: Assign a guest to a data room

https://www.helprange.com/public-api/guest/{guest_id}/assign/{data_room_id}

Adds a guest (from v1: Add a guest) to a data room and sends the room invitation e-mail (counted in the API e-mail budget). Already in the room: no new invitation.

Plans: Max, Unlimited, Deal Room Pass, trial. Auth: the API key in Authorization (bare, or Bearer hr_live_…) (v1). Scope: rooms:write. Operation id: v1AssignGuest

Parameters

NameInTypeDescription
guest_id requiredpathintegerGuest id. (min 1)
data_room_id requiredpathintegerData room id. (min 1)

Example request

curl -X POST https://www.helprange.com/public-api/guest/7/assign/10 \
  -H "Authorization: $HELPRANGE_API_KEY"

The samples read the key from the HELPRANGE_API_KEY environment variable.

Responses

StatusDescription
200OK
401Missing or invalid API key / OAuth token. Team keys: code invalid_key, key_revoked, key_expired or key_owner_removed.
402Your plan does not include the REST API (or this feature).
403v1: the key is invalid, or the folder / file / guest / data room is not yours (HTML page unless you send Accept: application/json). Team keys (v1 and v2): code insufficient_scope with required_scope – the key lacks the scope this endpoint needs.
404Not found.
429A usage limit was reached – wait Retry-After seconds.
Example response · 200
{
  "result": "success",
  "already_in_room": false
}

Try it

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.