SupDesk
PATCH/v1/articles/{id}

Update a help center article

Updates an existing help center article. Supply any article fields you want to change; status, if included, must be one of the supported values.

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

1 parameter · 4 body fields
idstringrequired
The unique identifier of the article to update.

The article fields to update; all fields are optional.

titlestringoptional
The article title.
bodystringoptional
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.

3 status codes
200Returns the updated article in the `data` object.
dataobjectoptional
401Returned when the request does not include valid authentication credentials.
errorobjectoptional
404Returned when no article exists with the given identifier.
errorobjectoptional

Error handling

A 401 is returned when the request does not include valid authentication credentials. A 404 is returned when the article identified by the id path parameter does not exist. status, if supplied, must be draft, published, or archived.