Skip to main content
Document Operations

Create personal link

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

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

Creates a personal link tied to the document user. Anyone who has the link URL can access the document as that user, so treat the URL like a secret. Delivering the link to the user is up to you; fynk sends no email.

A document user has at most one active personal link at a time; if one already exists, a 409 response is returned. Delete the existing link first to create a new one with a fresh URL.

Note: Personal links can only be created for users without a fynk account user in your account (has_account_user is false), and not while the document is in the draft or approved_draft stage. Attempting either will return a 409 response.

Authorizationstringheaderrequired

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

documentstringrequired

The document UUID

documentUserstringrequired

The document user UUID

Body

application/json
expires_atstring | null

When the link stops working. Defaults to 3 months from now; 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

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

Response

application/json

ShareableLinkResource

dataobjectrequired