PATCH/organizations/{organizationId}/projects/{projectId}/documents/{documentId}

Update a document

Updates draft content, title, labels, and review state.

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

If-Matchheader · stringoptional

Current resource ETag for optimistic concurrency.

Request body

application/jsonrequired

titlestringoptional

contentstringoptional

labelsarray<string>optional

review_stateenumoptional

Values: "not_requested" · "in_review" · "changes_requested" · "approved"

Responses

200application/json

Document updated.

{
  "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 was edited by another actor.

curl --request PATCH \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/projects/prj_01J8F5KM4MAB0V7YQ6P3N2R8D1/documents/doc_01J8F8W4S3P2N9B6M7K5Q1R0T' \ --header 'If-Match: W/"org-204"' \ --header 'Content-Type: application/json' \ --data '{ "title": "Mobile launch runbook v2", "content": "# Launch checklist\n\n- Verify monitoring\n- Approve release\n- Share status", "labels": [ "release", "mobile", "approved" ], "review_state": "approved"}'

{ "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\""}