STstuut
aether

Update a knowledge article

Providing content creates a new revision (optionally with an updated title or description); collection alone moves the article. Title or description changes require content to be sent as well.

patch/v2/aether/playbook/knowledge/{article_id}

Request

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

Path parameters

article_idstring required

Request body

contentstring

New article content (full replacement, not a diff)

titlestring

New title

descriptionstring

New description

collection'cash_application' | 'collections' | 'company' | 'credit_risk' | 'deductions' | 'disputes' | 'payments'

New collection

Response

Successful Response

idstring uuid required

Article ID

created_atstring date-time required

When this article was first created

titlestring required

Article title

descriptionstring nullable

What this article covers

contentstring nullable

Full article content

collectionstring required

Playbook collection

knowledge_type'declarative' | 'document' | 'procedural' required
status'archived' | 'published' required
scope'shared' | 'segment' | 'customer' required
customer_idstring nullable

Customer this article is scoped to

segment_idstring nullable

Segment this article is scoped to

published_atstring date-time nullable

When last published

archived_atstring date-time nullable

When archived

file_idstring uuid nullable

Reference document attachment

Changes

No recorded changes to this operation across all 2 revisions of this API.