Share links

An external link that gives anyone who holds it access to one published document.

Fields

The API name is what the API, MCP and the CLI use.

Name	API name	Type	Required	Description
ID	`id`	Record ID	Yes
Recipient email	`recipientEmail`	Text
Contact	`customercontactId`	Reference
Share snapshot	`sharesnapshotId`	Reference	Yes
Verification	`verification`	Constant	Yes	Fixed option from the allowed set for this field.
Expires	`expiresAt`	Date and Time	Yes
Created by	`createdBy`	User
Created at	`createdAt`	Date and Time	Yes
Updated by	`updatedBy`	User
Updated at	`updatedAt`	Date and Time	Yes
Opened by	`openedBy`	User
Opened at	`openedAt`	Date and Time
Verified by	`verifiedBy`	User
Verified	`verifiedAt`	Date and Time
Canceled by	`canceledBy`	User
Canceled at	`canceledAt`	Date and Time
Blocked by	`blockedBy`	User
Blocked at	`blockedAt`	Date and Time
Archived by	`archivedBy`	User
Archived at	`archivedAt`	Date and Time

Field	Points to	Kind
Contact `customercontactId`	Customer contacts	reference
Share snapshot `sharesnapshotId`	Share snapshots	reference

What you can do with a record. Every action also sends the webhook event sharelinks.<action>. Reads (find, get, count) work on every table.

Name	API name	Description	Where
Create	`create`	Add a new share link.	App · WebMCP · API · MCP · CLI
Edit	`update`	Save changes to this share link.	App · WebMCP · API · MCP · CLI
Cancel	`cancel`	Reverse the posted effect of this share link.	App · WebMCP · API · MCP · CLI

How a record moves from state to state. Archive and block can happen in any state.

Moments the record reaches on its own. Subscribe to them with a webhook.

Name	Webhook event	Description
First opened	`sharelinks.firstOpened`	The recipient opened the link for the first time.