Skip to main content
PUT
Update an article

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
title
any
description
any
content
any
plainContent
any
helpcenterCollection
string
author
string
project
string
isDraft
boolean
default:true
docId
number<double>
expectedVersion
number<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).

lexorank
string
upvotes
any
targetAudience
string
default:all
externalId
string
baseAudienceFilter
any
extendedAudienceFilter
any
tags
string[]
newCollectionId
string

Response

200 - application/json

Ok

Generic types for Document:

  • T - the type of _id
  • TQueryHelpers - Object with any helpers that should be mixed into the Query type
  • DocType - the type of the actual Document created
updatedAt
string
required
createdAt
string
required
sourceUsage
number<double>
required
version
number<double>
required
isDraft
boolean
required
targetAudience
string
required
tags
string[]
required
extendedAudienceFilter
any
baseAudienceFilter
any
docId
number<double>
author
object
helpcenterCollection
object
upvotes
any
plainContent
any
lexorank
string
project
object
externalId
string
content
any
title
any
description
any