Knowledge Base API
POST/api/v1/kb-articles/{id}/archive
Product availabilityAlgaPSAAlgaDesk

Archive a knowledge base article

Sets the article status to archived and clears client visibility on the linked document. Returns the updated article.

RBAC · document

Path parameters

idstring <uuid>Required
KB article UUID.

Response body

Success response 200 · schema KbArticleResponse

dataobjectRequired
A knowledge base article and its metadata.
article_idstring <uuid>Required
tenantstring <uuid>Required
document_idstring <uuid>Required
Underlying document backing the article.
titlestringRequired
slugstringRequired
article_typestringRequired
Enum: how_tofaqtroubleshootingreference
audiencestringRequired
Enum: internalclientpublic
statusstringRequired
Enum: draftreviewpublishedarchived
category_idstring <uuid>Nullable
review_cycle_daysintegerNullable
next_review_datestringNullable
published_atstringNullable
published_bystring <uuid>Nullable
document_namestringNullable
Joined from the documents table.
created_atstring
updated_atstring
metaobject

Response codes

200
Article archived.
400
Invalid request.
401
API key missing/invalid.
403
Caller lacks the required document permission.
404
Article not found.
500
Unexpected error.