SupDesk
POST/v1/articles

Create a help center article

Creates a help center article. Supply title and body; you can also set its status and associate it with a category using category_id. The created article is returned in the response.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Help center article details. title and body are required.

titlestringrequired
The article title.
bodystringrequired
The article content.
statusstringoptional
The article status: `draft`, `published`, or `archived`.
Allowed:draftpublishedarchived
category_idstringoptional
The identifier of the category to associate with the article.

2 status codes
201Returns the created article in the `data` object.
dataobjectoptional
401Returned when the request does not include valid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request does not include valid authentication credentials. title and body are required, and status, if supplied, must be draft, published, or archived.