Help center articles

Save an article draft

Changed on

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

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}/draft
  • Auth
    HTTP bearer

Path parameters

helpcenterArticleIdstring required

Request body

titleunknown
descriptionunknown
contentunknown
plainContentunknown
targetAudiencestring
tagsstring[]
authorunknown
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.

expectedArticleVersionnumber 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

Ok

unknown required

Changes