SUsuperit
kb

Update Article By Key

Update an existing article.

Scoped to the owning team: foreign and global articles return 404 so a team-scoped route cannot mutate another team's article (SUP-339 / BOLA).

patch/api/kb/{team_key}/articles/{article_key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

article_keystring required
team_keystring required

Request body

namestring nullable
slugstring nullable
descriptionstring nullable
articleType'business' | 'infrastructure' | 'procedure' | 'software' | 'system' | 'troubleshooting'
tagsstring[] nullable
compatibilitystring nullable
bodyMarkdownstring nullable
isActiveboolean nullable

Response

Successful Response

keystring required
namestring required
slugstring required
descriptionstring required
articleType'business' | 'infrastructure' | 'procedure' | 'software' | 'system' | 'troubleshooting' required
scope'global' | 'team' required
tagsstring[] required
compatibilitystring required
bodyMarkdownstring required
isActiveboolean required
versioninteger required
createdAtstring date-time required
updatedAtstring date-time required
isImportedboolean required
isEditableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.