Docmost Octri Preview
POST/pages/transclusion/unsync-reference

Detach a transclusion from its source

Detaches a transclusion from its source by replacing the live reference with a static copy of the source content on the referencing page. Supply referencePageId, sourcePageId, and transclusionId to identify the reference and its source block. The page identifiers must be UUIDs.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Identifies the transclusion reference to detach and the source block it points to.

referencePageIdstringrequired
Page holding the transclusion to detach.
sourcePageIdstringrequired
The UUID of the page containing the source block.
transclusionIdstringrequired
The identifier of the transcluded block.

3 status codes
200Returns a response confirming that the reference was detached.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
403Returned when detaching the reference is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the page or reference cannot be found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is forbidden from detaching the reference. A 404 is returned when the page or reference cannot be found. referencePageId, sourcePageId, and transclusionId are required; both page IDs must be UUIDs.