link

Make a link public

Lets anyone with the link open it with no email, after the general-solicitation warning, which acknowledged confirms: "Public links that describe a securities offering can count as general solicitation. If you're relying on Rule 506(b), keep links private. If you're using 506(c), you must verify every purchaser is accredited." Refused with public_link_blocked_506b for a document on a Rule 506(b) round, and with public_links_off when the workspace keeps links private. A public link has no list, passcode or downloads.

post/links/{link_id}/public

Request

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

Path parameters

link_idstring required

Request body

acknowledgedtrue required

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.