Links

List share links

Paginated list of share links for the team. Filter by `document_id`, `dataroom_id`, or `group_id` (dataroom group).

Creates a share link for a document or dataroom. Optional password, expiry, email allowlist, and other access controls. Pass `domain` + `slug` together to host the link on a verified custom domain. For dataroom links, pass `audience_type: "group"` + `group_id` to scope the link to a dataroom group.

Get a share link

Returns a single share link with its access controls and the public URL.

Update a share link

Partial update — only the fields you pass are changed. Useful for rotating passwords, updating expiry, or changing access controls. Pass `domain` + `slug` together to move the link onto a verified custom domain. For dataroom links, `audience_type` + `group_id` scope the link to a dataroom group (or back to `general`).

Revoke a share link (soft delete)

Soft-deletes the link. The public URL stops resolving immediately; the row is kept in the database for audit.

List link permissions

Per-item file permissions for a dataroom link. Empty when the link has no per-link overrides — viewers then see the full dataroom. Always empty for `audience_type: "group"` links: their visibility comes from the link's group and per-link overrides cannot be set (see the corresponding `PUT`).

Set link permissions

Replace the per-item file permissions of a dataroom link (full-replace semantics, matching the dashboard): the payload is the complete desired state, items not listed lose their override, and an empty array clears everything — hiding every item on this link. Ancestor folders of visible items are kept visible automatically. Rejected with `422` on links with `audience_type: "group"` — their group determines visibility; switch the link to `audience_type: "general"` first.