Links

Update a share link

Edit a share link's full gate set — rename, activate/deactivate, email/password/agreement gates, watermark and download/print/copy/capture protections, expiry, view cap, allow/blocklists, and notifications. Gate/access changes invalidate live visitor sessions; empty strings clear gate fields (JSON null is a no-op). Scope: links:write.

patch/links/{id}

Request

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

Path parameters

idstring required

Request body

namestring
activeboolean
kind'STANDARD' | 'CAMPAIGN' | 'INTERNAL'
accountIdstring

Empty string clears it

accountNamestring
emailRequiredboolean
emailVerifiedboolean
passwordstring
passwordClearboolean

Remove the existing password

ndaAgreementIdstring

Empty string clears it

gateAgreementIdstring

Empty string clears it

gateAgreementIdsstring[]

Replaces the whole set; [] clears

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

Empty string clears it

maxViewsinteger
ipAllowliststring[]

CIDR ranges

countryAllowliststring[]

ISO-2 codes

emailAllowliststring[]
emailBlockliststring[]

Response

Updated

Changes

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