Skip to main content
PUT
Update Article

Update Article

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

Request

Path Parameters

id
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.
name
string
Internal article name
title
string
The article title
handle
string
URL-safe handle
content
string
Article body content (HTML)
tags
array
Array of tag strings (replaces existing tags)
image
string
Featured image URL
template_suffix
string
Custom template suffix
seo_title
string
Custom page title for search engines
seo_desc
string
Meta description for search engines
seo_image
string
Social/share image URL 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.
status
integer
HTTP status code (200 on success)
state
string
"success" or "error"
data.article
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.
StatusmessageWhen
401Invalid or missing access token
403App doesn’t have the write_content scope
404Article not foundNo article with the specified ID exists
500error detailUnexpected server error