Help center articles

Create a new article

Changed on

Create a new help center article in a collection. title, description and content may be sent either localized ({ "en": ... }) or as a bare value, which is stored under the help center's default language. project, helpcenterCollection, docId, lexorank, plainContent and baseAudienceFilter are assigned by the server and ignored if sent. The article is created unpublished (isDraft: true) unless isDraft: false is passed.

content is TipTap JSON. Images are image nodes referencing a hosted image URL: { "type": "image", "attrs": { "src": "<url>" } }. To host images on the Gleap CDN, upload them first via POST /v3/uploads (or import from an existing URL via POST /v3/uploads/from-url) and use the returned fileUrl as the src.

post/helpcenter/collections/{helpcenterCollectionId}/articles

Request

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

Headers

projectstring required

Request body

titleunknown
descriptionunknown
contentunknown
plainContentunknown
helpcenterCollectionstring
authorstring
projectstring
isDraftboolean

true keeps the article unpublished. New articles are drafts unless false is sent; an update that leaves it out keeps the current state.

docIdnumber double
expectedVersionnumber double

Optimistic-concurrency token. When provided, the update is applied only if the article's current version still equals this value; otherwise the server rejects the write with 409 (and preserves the rejected content as a 'conflict' version). When omitted, the save falls back to last-write-wins (keeps the existing editor working until it is updated to send the token).

lexorankstring
upvotesunknown
targetAudiencestring

Who can read the article. New articles default to all; an update that leaves it out keeps the current audience.

externalIdstring
baseAudienceFilterunknown
extendedAudienceFilterunknown
tagsstring[]
newCollectionIdstring

Deprecated here. Only read by PUT .../articles/{id}/move (which has its own body); ignored on create/update.

Response

Ok

updatedAtstring required
createdAtstring required
extendedAudienceFilterunknown
baseAudienceFilterunknown
docIdnumber double
upvotesunknown
plainContentunknown
lexorankstring
externalIdstring
contentunknown
titleunknown
descriptionunknown
sourceUsagenumber double required
versionnumber double required
isDraftboolean required
targetAudiencestring required
tagsstring[] required

Changes

    • info

      the request property default value true was removed

    • info

      the request property default value all was removed