Skip to main content
PUT
Update Article

Update Article

Updates an existing article. Only provided fields will be updated.

Request

Path Parameters

string
required
The unique article ID to update

Body Parameters

All parameters are optional. Only provided fields will be updated. Fields may be sent at the top level, or nested under an article object.
string
Internal article name
string
The article title
string
URL-safe handle
string
Article body content (HTML)
array
Array of tag strings (replaces existing tags)
string
Featured image URL
string
Custom template suffix
string
Custom page title for search engines
string
Meta description for search engines

Response

The response uses the standard { status, state, message, data } envelope. On success state is "success" and the updated article is returned under data.article.
integer
HTTP status code (200 on success)
string
"success" or "error"
object
The updated article object

Example Response

Notes

  • Changing the handle will break existing links to the article.

Error Codes

Errors return the same envelope with state: "error" and a message.