---
title: v1: Assign a guest to a data room (POST /public-api/guest/{guest_id}/assign/{data_room_id}) | HelpRange API
description: POST /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).
url: https://www.helprange.com/developers/api/v1-assign-guest
---

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:** Pro, 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

| Name | In | Type | Description |
|---|---|---|---|
| `guest_id` required | path | integer | Guest id. (min 1) |
| `data_room_id` required | path | integer | Data room id. (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](https://www.helprange.com/developers/api#idempotency).

## Example request

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

```
const res = await fetch('https://www.helprange.com/public-api/guest/7/assign/10', {
  method: 'POST',
  headers: {'Authorization': 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/public-api/guest/7/assign/10',
    headers={'Authorization': 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.

## Responses

| Status | Description |
|---|---|
| `200` | OK |
| `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` | v1: 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. |
| `404` | Not found. |
| `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. |

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.
 API key

  Remember in this tab

guest_id (path, required)

data_room_id (path, required)

```

```