v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Create personal link

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

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.

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

Path parameters

documentstring required

The document UUID

documentUserstring required

The document user UUID

Request body

expires_atstring date-time nullable

When the link stops working. Defaults to 3 months from now; pass null for a link that never expires

messagestring nullable

A personal message shown to the user when they open the link

Example request

{
  "expires_at": "2026-10-19T12:00:00Z",
  "message": "Hi Emily, please review the updated contract."
}

Response

ShareableLinkResource

Example response

{
  "data": {
    "uuid": "5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0",
    "url": "https:app.fynk.com/share/5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0?token=...",
    "expires_at": "2026-10-19T12:00:00Z",
    "message": "Hi Emily, please review the updated contract."
  }
}