POST

v1: Add a guest

https://www.helprange.com/public-api/guest

Creates a guest of your team by e-mail (an existing guest of the team with this e-mail is reused). Nobody is e-mailed. Counts towards the daily cap of 1,000 guests.

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

Request body

Content types: application/json.

FieldTypeDescription
email requiredstringThe guest's e-mail.

Example request

curl -X POST https://www.helprange.com/public-api/guest \
  -H "Authorization: $HELPRANGE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-binary '{"email": "john@company.com"}'

The samples read the key from the HELPRANGE_API_KEY environment variable.

Responses

StatusDescription
200OK
400Invalid input – the message says which parameter.
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.
429A usage limit was reached – wait Retry-After seconds.
Example response · 200
{
  "id": 5
}

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.