v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB

Help center articles

Save an article draft

Create or update the staged draft of an article. The live article is never modified by this call; use the draft publish endpoint to promote it.

put/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}/draft

Path parameters

helpcenterArticleIdstring required

Request body

{"stackTrail":"components:schemas:HelpcenterArticleDraftDto:properties:title","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDraftDto:properties:description","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDraftDto:properties:content","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDraftDto:properties:plainContent","oasType":"schema","type":"unknown"}

targetAudiencestring

tagsstring[]

{"stackTrail":"components:schemas:HelpcenterArticleDraftDto:properties:author","oasType":"schema","type":"unknown"}

expectedDraftVersionnumber double

Optimistic-concurrency token for the draft itself. When provided, the upsert only applies if the stored draft's draftVersion still matches; otherwise 409 (mirrors the live-article guard) so two people editing the same draft don't clobber each other.

Response

{"stackTrail":"paths:/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}/draft:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}