v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Documents

Publish draft

Publish the document's current main (non-branch) draft, promoting it to the published version. No request body — the draft is consumed, so the response echoes the now-published document metadata.

Only the main draft is publishable here; a branch-attached draft is published by merging its branch (POST /api/v1/models/{modelId}/branch/{branchName}/merge), so a document with no main draft returns 404. Documents that require a pull request to publish return 400.

post/api/v2/documents/{identifier}/draft/publish

Path parameters

identifierstring required

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Example:abc123

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Response

Draft published successfully.

descriptionstring nullable required

Document description.

identifierstring required

Published document identifier.

namestring required

Document name.