---
title: Give a buyer access (POST /api/v2/folders/{folder_id}/buyers) | HelpRange API
description: POST /api/v2/folders/{folder_id}/buyers: Gives a buyer access to a product folder (any shop: Teachable, Thinkific, Shopify …): a personal protected link by e-mail for the folder's access length, the buyer id in the watermark.
url: https://www.helprange.com/developers/api/grant-buyer-access
---

POST

# Give a buyer access

`https://www.helprange.com/api/v2/folders/{folder_id}/buyers`

Gives a buyer access to a product folder (any shop: Teachable, Thinkific, Shopify …): a personal protected link by e-mail for the folder's access length, the buyer id in the watermark. The buyer gets one e-mail (counted in the team's API e-mail budget). 201 for a new buyer, 200 when they already had access.

**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:** `links:write`. **Operation id:** `grantBuyerAccess`

## Parameters

| Name | In | Type | Description |
|---|---|---|---|
| `folder_id` required | path | integer | Folder id (from List folders). (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).

## Request body

Content types: `application/json`, `application/x-www-form-urlencoded`.

| Field | Type | Description |
|---|---|---|
| `email` required | string | The buyer's e-mail. |
| `buyer_id` | string | Your own buyer / order id, shown in the watermark (optional). |

## Example request

```
curl -X POST https://www.helprange.com/api/v2/folders/31/buyers \
  -H "X-API-Key: $HELPRANGE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-binary '{"email": "buyer@example.com", "buyer_id": "order-1042"}'
```

```
const res = await fetch('https://www.helprange.com/api/v2/folders/31/buyers', {
  method: 'POST',
  headers: {'X-API-Key': process.env.HELPRANGE_API_KEY, 'Content-Type': 'application/json'},
  body: JSON.stringify({
    "email": "buyer@example.com",
    "buyer_id": "order-1042"
  }),
});
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/folders/31/buyers',
    headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
    json={
        "email": "buyer@example.com",
        "buyer_id": "order-1042",
    },
    timeout=60,
)
r.raise_for_status()
print(r.json())
```

The samples read the key from the `HELPRANGE_API_KEY` environment variable.

## Responses

| Status | Description |
|---|---|
| `201` | Created (200: existing buyer) |
| `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. |

Example response · 201

```
{
  "id": "31-buyer@example.com",
  "email": "buyer@example.com",
  "folder_id": 31,
  "folder": "Market report",
  "new_buyer": true,
  "access_ends_at": null
}
```

## 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

folder_id (path, required)  JSON body { "email": "buyer@example.com", "buyer_id": "order-1042" }

```

```