dataroom

Share a data room

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.

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

Path parameters

room_idstring required

Request body

labelstring
allowstring[]

Who may open it: emails or whole domains, ["jane@fund.com", "northwind.vc"].

foldersstring[]
downloadsboolean
detailed_analyticsboolean
protection'open' | 'protected' | 'locked'

Response

The result.

idstring required
document_idstring nullable required
document_titlestring required
urlstring required
access'named' | 'email' | 'verified' | 'public' required
labelstring nullable required
recipient_emailstring nullable required
allowstring[] required
downloadsboolean required
detailed_analyticsboolean required
passcodeboolean required
noticestring nullable required
protection'open' | 'protected' | 'locked' required
mark_style'band' | 'tiled' required
round_idstring nullable required
public_blockedstring nullable required
expires_atstring date-time nullable required
state'active' | 'paused' | 'expired' | 'revoked' required
paused_reasonstring nullable required
viewsinteger required
last_viewed_atstring date-time nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.