Update a knowledge document

Updates a knowledge document’s content and/or metadata. Only fields provided in the request body are updated — omitted fields are left unchanged.

PUT /api/knowledge/{id}

Update a knowledge document

cURL

curl --request PUT \
  --url https://core-api.getaptly.com/api/knowledge/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "name": "Updated Lease Addendum Policy",
  "html": "<p>Revised policy effective March 2026...</p>"
}
'

200

{
  "_id": "<string>"
}

Authorizations

x-token · string · header · required

Path Parameters

id · string · required

The knowledge document ID.

Body

application/json

name · string

New document title.

html · string

Replacement HTML content for the document body.

accessType · enum<string>

New access level.

Available options: public, private

Response

200

application/json

Document updated.

_id · string