Sign in
Harbors

Update Harbor Context

Replaces one Harbor context document.

Each successful request publishes the next immutable version. You can omit change_note.

A direct publication leaves an existing draft unchanged.

put/api/harbors/{harbor_id}/contexts/{context_id}

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the Harbor.

context_idstring uuid required

Unique identifier of the context document.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the context document.

Headers

X-Polytomic-Versionstring

Request body

change_notestring nullable

Optional note describing this published change.

contentstring required

Plain-text context content. Maximum 20,000 characters.

descriptionstring

Short summary of the context document. Maximum 1,000 characters.

titlestring required

Human-readable context title. Maximum 200 characters.

Example request

{
  "change_note": "Clarify fiscal-year terminology",
  "content": "Bookings use the contract signed date...",
  "description": "Definitions used in revenue reporting",
  "title": "Revenue definitions"
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}

Changes