Skip to main content
Document Operations

Update personal link

<small>Requires an API token with the Document Manager role.</small>

PATCH
/documents/{document}/users/{documentUser}/personal-link

Updates the document user's active personal link. The link URL never changes; to get a fresh URL, delete the link and create a new one.

Returns a 404 response when the user has no active personal link.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

documentUserstringrequired

The document user UUID

Body

application/json
expires_atstring | null

When the link stops working. Pass null for a link that never expires

Example: 2026-10-19T12:00:00Z
messagestring | null

A personal message shown to the user when they open the link. Pass null to remove the message

Maximum string length: 65535
Example: Hi Emily, please review the updated contract.

Response

application/json

ShareableLinkResource

dataobjectrequired

Still need help? Share an idea