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`).

Authorization

bearerAuth links.write

AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: links.write

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

audience_type?string

Switch the link's audience. group (dataroom links only) requires group_id — either passed here or already on the link; the link becomes email-protected. general clears the group scope.

Value in"general" | "group"

group_id?|

Id of a dataroom group in the link's dataroom. Set together with audience_type: "group" (or on its own to swap the group of an existing group link). Pass audience_type: "general" to clear the group scope; group_id: null on its own is rejected.

name?string

expires_at?|

Formatdate-time

password?|

Pass null to remove the password.

Length1 <= length

email_protected?boolean

email_authenticated?boolean

allow_download?boolean

allow_list?array<string>

deny_list?array<string>

enable_watermark?boolean

watermark_config?|

Watermark configuration. Pass an object to replace the existing config, or null to clear it. Omit to leave it unchanged.

enable_screenshot_protection?boolean

enable_confidential_view?boolean

enable_agreement?boolean

Require viewers to accept an agreement (NDA) before viewing. Set together with agreement_id when enabling. Available on the Data Rooms plan and above.

agreement_id?|

ID of the Agreement viewers must accept. Pass null to clear.

domain?string

Custom domain to host the link on. Must be a verified domain connected to your team and must be sent together with slug. Requires the Business plan for document links or the Data Rooms plan for dataroom links.

slug?string

Path segment for the custom-domain URL. Must be sent together with domain and be unique within that domain.

welcome_message?|

Custom welcome message shown to viewers before opening the link. Pass null to clear. Requires a plan with custom welcome messages.

enable_notification?boolean

Notify the team on each view of this link.

show_banner?boolean

Show the end-of-document banner / signup form to viewers.

custom_fields?array<>

Replace the link's custom form fields with this list (full replace; pass [] to remove all). Display order follows the array. Requires a plan with custom form fields.

Response Body

`application/json`

curl -X PATCH "https://api.papermark.com/v1/links/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "clxabc1234567890",
  "object": "link",
  "name": "Q4 pitch — Acme Ventures",
  "target_type": "document",
  "audience_type": "general",
  "group_id": "string",
  "document_id": "clxdoc0987654321",
  "dataroom_id": "string",
  "url": "https://www.papermark.com/view/clxabc1234567890",
  "domain": "dataroom.acme.com",
  "slug": "q4-acme-ventures",
  "expires_at": "2019-08-24T14:15:22Z",
  "is_password_protected": true,
  "email_protected": true,
  "email_authenticated": true,
  "allow_download": true,
  "allow_list": [
    "string"
  ],
  "deny_list": [
    "string"
  ],
  "enable_watermark": true,
  "watermark_config": {
    "text": "Confidential — {{email}} — {{date}}",
    "is_tiled": true,
    "position": "middle-center",
    "rotation": 45,
    "color": "#000000",
    "font_size": 24,
    "opacity": 0.5
  },
  "enable_feedback": true,
  "enable_screenshot_protection": true,
  "enable_confidential_view": true,
  "enable_agreement": true,
  "agreement_id": "string",
  "welcome_message": "string",
  "enable_notification": true,
  "show_banner": true,
  "custom_fields": [
    {
      "type": "SHORT_TEXT",
      "identifier": "company",
      "label": "Company name",
      "placeholder": "string",
      "required": true,
      "disabled": true,
      "order_index": 0
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "bad_request",
    "message": "The request body is not valid JSON.",
    "doc_url": "https://www.papermark.com/docs/api/errors#bad_request",
    "details": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token. Include an `Authorization: Bearer <token>` header.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Token is missing required scope: links.write.",
    "doc_url": "https://www.papermark.com/docs/api/errors#forbidden",
    "details": null
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Link link_abcd1234 not found.",
    "doc_url": "https://www.papermark.com/docs/api/errors#not_found",
    "details": null
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The slug `q4-acme-ventures` is already in use on domain `dataroom.acme.com`.",
    "doc_url": "https://www.papermark.com/docs/api/errors#conflict",
    "details": null
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "Invalid request body.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unprocessable_entity",
    "details": {
      "formErrors": [],
      "fieldErrors": {
        "expires_at": [
          "Invalid datetime"
        ]
      }
    }
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 30s.",
    "doc_url": "https://www.papermark.com/docs/api/errors#rate_limit_exceeded",
    "details": null
  }
}

Update a share link

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`