---
title: "Update a share link"
method: PATCH
path: "/links/{id}"
tags: ["Links"]
---

# Update a share link

`PATCH /links/{id}`

## Request

- Base URL: `https://dataroom.corgi.com/api/v1`
- URL: `https://dataroom.corgi.com/api/v1/links/{id}`
- Auth: HTTP bearer

Edit a share link's full gate set — rename, activate/deactivate, email/password/agreement gates, watermark and download/print/copy/capture protections, expiry, view cap, allow/blocklists, and notifications. Gate/access changes invalidate live visitor sessions; empty strings clear gate fields (JSON `null` is a no-op). Scope: `links:write`.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `active` boolean
  - `kind` 'STANDARD' | 'CAMPAIGN' | 'INTERNAL'
  - `accountId` string: Empty string clears it
  - `accountName` string
  - `emailRequired` boolean
  - `emailVerified` boolean
  - `password` string
  - `passwordClear` boolean: Remove the existing password
  - `ndaAgreementId` string: Empty string clears it
  - `gateAgreementId` string: Empty string clears it
  - `gateAgreementIds` string[]: Replaces the whole set; [] clears
  - `watermark` boolean
  - `allowDownload` boolean
  - `allowPrint` boolean
  - `disableCopy` boolean
  - `blockScreenCapture` boolean
  - `notifyOnView` boolean
  - `notifyOnDownload` boolean
  - `notifyCc` string[]
  - `expiresAt` string, date-time: Empty string clears it
  - `maxViews` integer
  - `ipAllowlist` string[]: CIDR ranges
  - `countryAllowlist` string[]: ISO-2 codes
  - `emailAllowlist` string[]
  - `emailBlocklist` string[]

## Response `200`

Updated

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/corgi/apis/dataroom-api.md) - [All operations](https://skmtc.dev/corgi/apis/dataroom-api/llms.txt) - [OpenAPI document](https://skmtc.dev/corgi/apis/dataroom-api/revisions/73f75ef04a00?raw)
