Sign in
HelpCenter

Update article

put/v1/helpcenter/articles/{id}

Path parameters

idinteger required

Article identifier.

Request body

{"stackTrail":"paths:/v1/helpcenter/articles/{id}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

Created

_idinteger nullable
titlestring nullable
spoilerstring nullable

Spoiler displayed under the title

languagestring nullable

2-letter language code

bodystring nullable

Body of the article in Markdown format

isDraftboolean nullable

Whether this is a draft article

slugstring nullable

Auto-generated URL slug of the article, e.g. infoset.help/acmeinc/articles/{id}-{slug}

deskstring required

ID of the help center of this article

departmentIdinteger nullable
collectioninteger nullable

ID of the collection of this article

{"stackTrail":"components:schemas:HelpdeskArticle:properties:createdAt","oasType":"schema","type":"unknown","description":"Creation date","nullable":true}
{"stackTrail":"components:schemas:HelpdeskArticle:properties:updatedAt","oasType":"schema","type":"unknown","description":"Last update date","nullable":true}

Changes

No recorded changes to this endpoint across all 1 revision of this API.