Sign in
OpenAPI 3.0.02026-08-18305331605.3 KB

6bb0c3577de2

Help center articles

Update an article

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}

Path parameters

helpcenterArticleIdstring 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

Ok

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