Skip to navigation
API ReferenceHarbors

Save Harbor Context Draft

Beta

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
OR
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

Headers

X-Polytomic-VersionstringOptional
X-Polytomic-Harbor-SessionstringOptional

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstringOptional

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

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

OK
dataobjectOptional
The context draft

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error