Share snapshots

An external copy of one business document, fixed at the moment it was published.

Fields

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

NameAPI nameTypeRequiredDescription
IDidRecord IDYes
LocalelocaleConstantYesFixed option from the allowed set for this field.
RecordtableUidConstantYesBusiness table this row points to.
Record IDrecordIdTextYes
VersionversionWhole NumberYesWhole number without fractional part.
Source updatedsourceUpdatedAtDate and Time
Created bycreatedByUser
Created atcreatedAtDate and TimeYes
Withdrawn bywithdrawnByUser
Withdrawn atwithdrawnAtDate and Time
Blocked byblockedByUser
Blocked atblockedAtDate and Time
Archived byarchivedByUser
Archived atarchivedAtDate and Time

Actions

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

NameAPI nameDescriptionWhere
CreatecreateAdd a new share snapshot.App · WebMCP · API · MCP · CLI