v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB

API Product Documentation

Update an API Product Document

Updates a document for an API product.

patch/v2/api-products/{apiProductId}/documents/{id}

Request body

parent_document_idstring uuid nullable

Parent document Id. If this value is explicitly set to null, the document will be put as a top level document at the bottom of the tree.

slugstring nullable

document slug. must be unique accross documents belonging to an api product

status'published' | 'unpublished'

titlestring nullable

document title

contentstring nullable

Can be markdown string content or base64 encoded string

metadataobject

Example request

{
  "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  "slug": "path-for-seo",
  "title": "How to update a document in Konnect DocumentHub",
  "content": "YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc="
}

Response

API product document

idstring uuid required

parent_document_idstring uuid nullable required

titlestring required

slugstring required

status'unpublished' | 'published' required

metadataobject required

contentstring required

The unencoded markdown string of the api product document.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}