Brand API links with a custom domain

By default a link created through the API resolves on the marketing domain — https://www.papermark.com/view/{id}. If you have a custom domain connected to your workspace, you can have the API mint links on it instead, e.g. https://dataroom.acme.com/q4-acme-ventures — the same branded URL your manually-created links use.

Prerequisites

1. A verified custom domain. Add and verify the domain in the Papermark dashboard first (Settings → Domains). The API only accepts domains that belong to your team and have passed DNS verification.
2. The right plan. Custom domains require:
   • the Business plan (or higher) for document links, and
   • the Data Rooms plan (or higher) for dataroom links.

Create a link on a custom domain

Pass domain and slug together in the POST /v1/links body. domain is the verified domain; slug is the path segment of the URL.

TOKEN=pm_live_…

curl -X POST https://api.papermark.com/v1/links \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dataroom_id": "dataroom_abcd1234",
    "name": "Acme Ventures — Q4",
    "domain": "dataroom.acme.com",
    "slug": "q4-acme-ventures",
    "email_protected": true
  }'

The response url is the branded URL:

{
  "id": "link_abcd1234",
  "object": "link",
  "url": "https://dataroom.acme.com/q4-acme-ventures",
  "domain": "dataroom.acme.com",
  "slug": "q4-acme-ventures",
  ...
}

Omit both fields and the link falls back to the default papermark.com/view/{id} URL.

Move an existing link onto a custom domain

The same pair works on PATCH /v1/links/{id}:

curl -X PATCH https://api.papermark.com/v1/links/link_abcd1234 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "dataroom.acme.com",
    "slug": "q4-acme-ventures"
  }'

Errors

Required scopes

links.write — the same scope used to create or update any link.