POST/organizations/{organizationId}/projects/{projectId}/documents/{documentId}/publish

Publish a document

Creates an immutable published version of a draft document.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenBearerAuthoptional
Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

projectIdpath · stringrequired
documentIdpath · stringrequired
Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/json
messagestringoptional
notify_subscribersbooleanoptional

Responses

200application/json

Document published.

{
  "id": "doc_01J8F8W4S3P2N9B6M7K5Q1R0T",
  "project_id": "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1",
  "title": "Mobile launch runbook",
  "slug": "mobile-launch-runbook",
  "content": "# Launch checklist\n\n- Verify monitoring\n- Approve release",
  "state": "published",
  "version": 4,
  "labels": [
    "release",
    "mobile"
  ],
  "review_state": "approved",
  "published_at": "2026-09-02T18:00:00Z",
  "etag": "W/\"document-4\""
}
idstringoptional
project_idstringoptional
titlestringoptional
slugstringoptional
contentstringoptional
statestringoptional
versionintegeroptional
labelsarray<string>optional
review_statestringoptional
published_atobject · date-timeoptional
etagstringoptional
409

Document has no changes to publish.

Powered by heyo-docs