v4

OpenAPI 3.0.02026-07-31257282489.4 KB

Help center articles

Create a new article

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.

post/helpcenter/collections/{helpcenterCollectionId}/articles

Headers

projectstring required

Request body

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:title","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:description","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:content","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:plainContent","oasType":"schema","type":"unknown"}

helpcenterCollectionstring

authorstring

projectstring

isDraftboolean

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

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:upvotes","oasType":"schema","type":"unknown"}

targetAudiencestring

externalIdstring

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:baseAudienceFilter","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDto:properties:extendedAudienceFilter","oasType":"schema","type":"unknown"}

tagsstring[]

newCollectionIdstring

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

Response

updatedAtstring required

createdAtstring required

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:extendedAudienceFilter","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:baseAudienceFilter","oasType":"schema","type":"unknown"}

docIdnumber double

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:upvotes","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:plainContent","oasType":"schema","type":"unknown"}

lexorankstring

externalIdstring

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:content","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:title","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterArticleDocument:allOf:properties:description","oasType":"schema","type":"unknown"}

sourceUsagenumber double required

versionnumber double required

isDraftboolean required

targetAudiencestring required

tagsstring[] required