Help center articles

Update an article

Changed on

Update a help center article. content is TipTap JSON; images are image nodes referencing a hosted image URL ({ "type": "image", "attrs": { "src": "<url>" } }) — upload files via POST /v3/uploads first and use the returned fileUrl as the src.

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

Request

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

Path parameters

helpcenterArticleIdstring 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

  • fd83cd1963c4Revision changes
    • info

      the request property default value true was removed

    • info

      the request property default value all was removed