link

Create a share link

Makes a link to a document and returns its URL; Binderwork doesn't send it, so give the URL to the person yourself. access: named (for one person, opens with no gate, label is required), email (asks the reader's email, the default), verified (emails a six-digit code first). allow limits it to emails or whole domains, such as ["jane@fund.com", "northwind.vc"], and makes it verified. round_id ties it to a round. Downloads are off unless allowed.

post/documents/{document_id}/links

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/documents/{document_id}/links
  • Auth: HTTP bearer

Path parameters

document_idstring required

From document_list or document_add.

Request body

access'named' | 'email' | 'verified'

named: one person, no gate; email: asks their email (default); verified: emails a code.

labelstring

Who it is for, as the person said it: "Jane Doe, Sequoia". Required for named.

recipient_emailstring email

Their email, so their visits show under their name.

allowstring[]

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

downloadsboolean

Let them download the file.

detailed_analyticsboolean
round_idstring
protection'open' | 'protected' | 'locked'

open; protected (default) marks pages with the reader; locked also verifies email.

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.