Skip to main content
Document Operations

Create public link

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

POST
/documents/{document}/public-link

Creates a public link for the document. Anyone who has the link URL can view the document with it, so treat the URL like a secret.

A document has at most one active public 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: Public links cannot be created while the document is in the draft or approved_draft stage. Attempting to do so will return a 409 response.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

documentstringrequired

The document 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

Response

application/json

ShareableLinkResource

dataobjectrequired

Still need help? Share an idea