SupDesk API
PATCH/v1/articles/{id}

Update a help center article

Updates an existing help center article. Supply any fields you want to change, and use status to set the article to draft, published, or archived.

  • 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; fields you omit are not specified for change.

titlestringoptional
The article title.
bodystringoptional
The article content.
statusstringoptional
The article status: draft, published, or archived.
Allowed:draftpublishedarchived
category_idstringoptional
The unique 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 lacks valid authentication credentials.
errorobjectoptional
404Returned when no article exists with the given `id`.
errorobjectoptional

Error handling

A 401 is returned when the request lacks valid authentication credentials. A 404 is returned when the id path parameter does not identify an existing article. status must be draft, published, or archived when provided.