Skip to main content
PUT
Save an article draft

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

helpcenterArticleId
string
required

Body

application/json

Staged edits to a help center article that are not yet live. There is at most one working copy per article (unique on article). The article keeps serving its own content until the draft is published.

title
any
description
any
content
any
plainContent
any
targetAudience
string
tags
string[]
author
any
expectedDraftVersion
number<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.

expectedArticleVersion
number<double>

The live article version the sending editor session loaded. Guards draft CREATION: a tab that loaded the article before someone else's publishes would otherwise seed a brand-new draft from its outdated editor state — that stale draft overlays everyone's editor (the article looks "reverted" in the dashboard) and, because baseVersion used to be stamped from the then-current live version, it also publishes without tripping the staleness guard. When provided and it no longer matches the live version, the save is rejected with 409 instead (the rejected state is kept as a 'conflict' version).

Response

200 - application/json

Ok