links

A link is the public-facing URL someone uses to view a document or dataroom. Links carry their own access controls (password, email gating, expiry, download permission); the document or dataroom behind them just sits there.

list

papermark links list [--document <id>] [--dataroom <id>] [--group <gid>] [--limit <n>] [--cursor <id>]

Lists share links. Filter by document, dataroom, or dataroom group, or omit all three for all links.

papermark links list --document doc_aBc123

For dataroom-bound links specifically, papermark datarooms links <id> is an ergonomic equivalent that takes the dataroom ID positionally instead of as a flag.

get

papermark links get <id>

Fetches one link by ID. Includes its access controls but not the view history; use views list for that.

create

papermark links create \
  (--document <id> | --dataroom <id>) \
  [--preset <id>] \
  [--group <gid>] \
  [--name <name>] \
  [--password <password>] \
  [--expires <iso-8601>] \
  [--email-protected] \
  [--email-authenticated] \
  [--allow-download] \
  [--allow-list <items>] \
  [--deny-list <items>] \
  [--confidential-view] \
  [--screenshot-protection] \
  [--agreement <id>] \
  [--welcome-message <msg>] \
  [--notification <on|off>] \
  [--banner] \
  [--custom-fields <json>] \
  [--domain <domain> --slug <slug>] \
  [--watermark] \
  [--watermark-text <text>] \
  [--watermark-tiled <on|off>] \
  [--watermark-position <pos>] \
  [--watermark-rotation <deg>] \
  [--watermark-color <hex>] \
  [--watermark-font-size <n>] \
  [--watermark-opacity <n>]

Either --document or --dataroom is required (exactly one).

The seven --watermark-* config flags must be passed together. Pass --watermark alone to enable the overlay with viewer defaults.

$ papermark links create \
    --document doc_KlmN456 \
    --password "open-sesame" \
    --expires 2026-12-31T00:00:00Z \
    --email-protected
ID:    link_abcd1234
URL:   https://papermark.com/view/abcd1234efgh

Presets

--preset <id> seeds the link from a saved link preset. Every preset-controlled setting becomes the default — password, expiry, email protection, downloads, allow/deny lists, watermark, screenshot protection, confidential view, agreement, welcome message, notifications, banner, and custom fields. Any flag you also pass overrides the preset.

When --preset is used, boolean flags you leave unset defer to the preset instead of forcing the setting off.

The preset's social-card metadata (custom OG tags — title, description, image, favicon) is applied too. Because there is no image-upload path in the CLI/API, a preset is the only way to set a link's preview metadata.

Custom fields

--custom-fields takes a JSON array of field objects. Each field needs a type (one of SHORT_TEXT, LONG_TEXT, NUMBER, PHONE_NUMBER, URL, CHECKBOX), an identifier, and a label; placeholder, required, and disabled are optional.

papermark links create --document doc_KlmN456 \
  --custom-fields '[{"type":"SHORT_TEXT","identifier":"company","label":"Company","required":true}]'

The number of custom fields a link can carry is capped by your plan.

update

papermark links update <id> [flags]

Change a link's access controls in place. The URL stays the same; viewers don't need to be re-notified. PATCH semantics: omitted flags are unchanged, but a passed value replaces the current one.

Boolean access controls are tri-state and take on or off:

Watermark config on update is PATCH-style: pass all seven --watermark-* flags together to replace the config, or pass --watermark-clear to drop it.

papermark links update link_abcd1234 --confidential-view on

delete

papermark links delete <id>

Revokes the link. The URL stops working immediately; existing viewers in flight see an "expired" page on the next request.

permissions

papermark links permissions get <id>
papermark links permissions set <id> (--file <path> | --item <itemId> --type <document|folder> [--view on|off] [--download on|off] | --clear)

Per-item file permissions on a dataroom link: control which documents and folders this specific link shows, without creating a group. With no overrides, viewers see the full dataroom.

Unlike group permissions, set here uses full-replace semantics, matching the dashboard: the payload is the complete desired state, items not listed lose their override, and --clear removes every override, which hides every item on the link. Ancestor folders of visible items stay visible automatically.

On links with a group audience these overrides are ignored; the group's permissions take precedence.

# Show only the teaser deck on this link
papermark links permissions set link_abcd1234 \
  --item ddoc_3f9 --type document --view on

Required scopes

For dataroom-bound links, you also need datarooms.read on the referenced dataroom.

Related

• datarooms groups: named audiences with reusable permissions, shared via --group links
• Guide: Share a dataroom with an investor group