Skip to main content

Update, Publish & Lifecycle

Update the overlay draft, publish it to project fields and doctypes into the registry and classifier, unpublish to retract, or delete to remove it fully.

Updating an overlay edits its draft; if the overlay is already published, the update auto-forks a fresh draft so the live overlay is untouched until you publish again. Publishing projects the latest version into your workspace: authored fields become pinned registry rows (protected from cleanup), and custom doctypes become classifier types on the overlay axis. Unpublishing flips the published version back to a draft and reverses the projection; deleting removes the overlay and reverses the projection too.

Publish, unpublish, and delete change extraction and classification behavior for your workspace. They are write-scope operations; treat publishing an overlay like a configuration change, not a read.
PATCH/v1/customer-ontologies/{id}

Body parameters

namestringRename the overlay.
descriptionstringUpdate the description.
doctypesobject[]Replace the doctype set.
fieldsobject[]Replace the field set.
POST/v1/customer-ontologies/{id}/publish
POST/v1/customer-ontologies/{id}/unpublish
DELETE/v1/customer-ontologies/{id}

curl

The lifecycle is designed so nothing changes out from under a running pipeline: updates land on a draft, publishing swaps the projection atomically, and unpublish or delete reverse it. Verify the outcome with the published-overlay preview endpoint, which shows exactly the custom doctypes the classifier will apply.

Related

Customer Overlays
Import an Overlay
Field Registry