Links

Create a share link

For a document or a room, with the full gate set (email/password/agreement gates, IP + country + email allow/blocklists, expiry, view cap, protections). Watermark/NDA are forced off when the plan lacks them. Requires links:write plus a documents scope (document target) or a datarooms scope (room target). Explicit slug collisions on the same domain return 409.

post/links

Request

  • Base URL
    https://dataroom.corgi.com/api/v1
  • Auth
    HTTP bearer

Request body

namestring required
documentIdstring

Exactly one of documentId or dataRoomId

dataRoomIdstring
kind'STANDARD' | 'CAMPAIGN' | 'INTERNAL'
slugstring

Auto-generated when omitted

domainstring
accountIdstring
accountNamestring
emailRequiredboolean
emailVerifiedboolean
passwordstring
ndaAgreementIdstring

Legacy single NDA gate (agreement id)

gateAgreementIdstring

Single agreement gate

gateAgreementIdsstring[]

Multiple agreement gates; visitor must accept all

watermarkboolean
allowDownloadboolean
allowPrintboolean
disableCopyboolean
blockScreenCaptureboolean
notifyOnViewboolean
notifyOnDownloadboolean
notifyCcstring[]
expiresAtstring date-time
maxViewsinteger
ipAllowliststring[]

CIDR ranges

countryAllowliststring[]

ISO-2 codes

emailAllowliststring[]
emailBlockliststring[]

Response

Created (returns a working share url)

Changes

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