Site share links

Control how you share docs externally by managing share links for a site.

Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing and revoking or updating existing ones.

The ShareLink object

Attributes

objectstring · enumRequired

Type of Object, always equals to "share-link"

Possible values:

idstringRequired

Unique identifier for the share-link

createdAtstring · date-timeRequired

namestring · max: 50Optional

Name of the share link

activebooleanOptional

The ShareLink object

{
  "object": "share-link",
  "id": "text",
  "createdAt": "2026-08-08T10:40:11.599Z",
  "name": "text",
  "active": true,
  "urls": {
    "published": "https://example.com"
  }
}