---
title: "Share a data room"
method: POST
path: "/rooms/{room_id}/links"
tags: ["dataroom"]
---

# Share a data room

`POST /rooms/{room_id}/links`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/rooms/{room_id}/links`
- Auth: HTTP bearer

Makes a link to a data room, or to some of its folders (each with everything inside), and returns its URL; Binderwork doesn't send it, so give the URL to the person yourself. Readers confirm their email with a code first. allow limits it to emails or whole domains, such as ["jane@fund.com", "northwind.vc"]. Downloads are off unless allowed.

## Path parameters

- `room_id` string, required

## Request body

- object
  - `label` string
  - `allow` string[]: Who may open it: emails or whole domains, ["jane@fund.com", "northwind.vc"].
  - `folders` string[]
  - `downloads` boolean
  - `detailed_analytics` boolean
  - `expires_at` union: A day (the link works through its end) or a moment.
    - string, date
    - string, date-time
  - `protection` 'open' | 'protected' | 'locked'

## Response `200`

The result.

- object
  - `id` string, required
  - `document_id` string, nullable, required
  - `document_title` string, required
  - `room` object, nullable, required
    - `id` string, required
    - `folders` object[], required
      - `id` string, required
      - `name` string, required
  - `url` string, required
  - `access` 'named' | 'email' | 'verified' | 'public', required
  - `label` string, nullable, required
  - `recipient_email` string, nullable, required
  - `allow` string[], required
  - `access_requests` object[], required
    - `id` string, required
    - `email` string, required
    - `kind` 'access' | 'nda_waiver', required
    - `created_at` string, date-time, required
  - `downloads` boolean, required
  - `detailed_analytics` boolean, required
  - `passcode` boolean, required
  - `nda` object, nullable, required
    - `document_id` string, required
    - `title` string, required
  - `notice` string, nullable, required
  - `protection` 'open' | 'protected' | 'locked', required
  - `mark_style` 'band' | 'tiled', required
  - `round_id` string, nullable, required
  - `round` object, nullable, required
    - `id` string, required
    - `name` string, required
    - `mode` '506b' | '506c' | 'reg_s', required
  - `public_blocked` string, nullable, required
  - `expires_at` string, date-time, nullable, required
  - `state` 'active' | 'paused' | 'expired' | 'revoked', required
  - `paused_reason` string, nullable, required
  - `preshare` object, nullable, required
    - `flags` object[], required
      - `key` string, required
      - `kind` 'ssn' | 'card' | 'iban' | 'routing' | 'ein' | 'cap' | 'comments' | 'paths' | 'author', required
      - `document_id` string, required
      - `document` string, required
      - `page` integer, nullable, required
      - `text` string, required
      - `holds` boolean, required
      - `boxes` object[], required
        - `page` integer, required
        - `x` number, required
        - `y` number, required
        - `width` number, required
        - `height` number, required
    - `checked` string[], required
    - `acknowledged` object, nullable, required
      - `by` string, required
      - `at` string, date-time, required
    - `advisory` object[], required
      - `key` string, required
      - `document_id` string, required
      - `document` string, required
      - `page` integer, nullable, required
      - `text` string, required
      - `band` 'high' | 'medium' | 'low', required
      - `question` string, required
      - `probability` number, required
      - `source` 'model' | 'agent', required
    - `skipped` string[], required
  - `views` integer, required
  - `last_viewed_at` string, date-time, nullable, required
  - `created_at` string, date-time, required

## Other responses

- `202`: Called by an agent or an API key, so the call did not run. A person approves it at approval_url; then GET the Location.
- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)