Skip to navigation
API ReferenceKnowledge Base

Update a knowledge entry

Requires a user credential: a workspace API key has no author to attribute the change to and receives 403. Send at least one field. Changing an always entry, or making one, also requires a workspace admin or owner.

Requires the knowledge:write API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Path parameters

entryIdstringRequired
Knowledge base entry UUID.

Request

This endpoint expects an object.
titlestringOptional
contentstringOptional
categoryenumOptional
Allowed values:
statusenumOptional
Allowed values:
priorityenumOptional

When agents get the entry; see Priority.

Allowed values:
tagslist of stringsOptional
Replaces the existing tags.

Response

The updated entry.
idstringformat: "uuid"
titlestring
contentstring
categoryenum
Allowed values:
statusenum
Only active entries are given to agents.
Allowed values:
priorityenum

When agents get the entry; see Priority.

Allowed values:
sourceenum
Allowed values:
tagslist of strings
confidencestring or null
createdBystring or nullformat: "uuid"
createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error