Save Harbor Context Draft | Polytomic Docs

curl -X PUT https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/contexts/248df4b7-aa70-47b8-a036-33ac447e668d/draft \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "content": "Bookings use the contract signed date...",
  "title": "Revenue definitions"
}'

{
  "data": {
    "base_revision_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "change_note": "string",
    "content": "string",
    "context_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "created_by_type": "string",
    "description": "string",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "title": "string",
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "updated_by_type": "string"
  }
}

Creates or completely replaces the mutable draft for a Harbor context document.

The request supplies the complete draft payload. If a draft already exists, this request replaces it while preserving the draft ID, creation metadata, and base_revision_id.

A new draft for a published document records the current revision as its base. An unpublished document’s initial draft keeps a null base when replaced. Saving a draft does not change published content or its updated_at. Creator and updater provenance comes from the request actor; system actors have a null actor ID.

Creates or completely replaces the mutable draft for a Harbor context document. The request supplies the complete draft payload. If a draft already exists, this request replaces it while preserving the draft ID, creation metadata, and `base_revision_id`. A new draft for a published document records the current revision as its base. An unpublished document's initial draft keeps a null base when replaced. Saving a draft does not change published content or its `updated_at`. Creator and updater provenance comes from the request actor; system actors have a null actor ID.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

harbor_idstringRequiredformat: "uuid"

Unique identifier of the Harbor.

context_idstringRequiredformat: "uuid"

Unique identifier of the context document.

Request

This endpoint expects an object.

contentstringRequired

Complete plain-text draft content. Maximum 20,000 characters.

titlestringRequired

Human-readable draft title. Maximum 200 characters.

change_notestring or nullOptional

Optional note stored with the draft and copied to the published version on promotion.

descriptionstringOptional

Short summary of the draft. Maximum 1,000 characters.

Response

dataobjectOptional

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors