Update article

PUT 
/openapi/2025-06/articles/:id

Update an existing article by its ID.

Request

Path Parameters

id stringrequired

Article ID

application/json

Body

Bodyrequired

article objectrequired

Article data to be updated

titlestring

Article title. The title is optional and can be up to 100 characters

Possible values: <= 100 characters

excerptstring

Article summary/teaser text. The summary is optional and can be up to 255 characters

Possible values: <= 255 characters

contentstring

Full article content

publishedboolean

Whether the article is published

published_atstring

Publication timestamp

handlestring

URL-friendly article identifier

authorstring

Author name

seo_titlestring

Custom SEO title

seo_descriptionstring

SEO meta description

seo_keywordsstring[]

SEO keywords

blog_idsstring[]

IDs of associated blogs/collections

image object

Featured image object

srcstring

Image URL

widthint32

Width

heightint32

Height

Example

{
  "article": {
    "title": "string",
    "excerpt": "string",
    "content": "string",
    "published": true,
    "published_at": "string",
    "handle": "string",
    "author": "string",
    "seo_title": "string",
    "seo_description": "string",
    "seo_keywords": [
      "string"
    ],
    "blog_ids": [
      "string"
    ],
    "image": {
      "src": "string",
      "width": 0,
      "height": 0
    }
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

article object

Article

idstring

Article ID

titlestring

Title of the article

excerptstring

Short summary or preview of the article content

contentstring

Full content of the article

image object

Image associated with the article containing src, width, height, and alt

srcstring

Image URL

widthint32

Width

heightint32

Height

pathstring

Path

publishedboolean

Whether the article is published or not

handlestring

URL-friendly identifier for the article

seo_titlestring

Custom SEO title

seo_descriptionstring

SEO meta description

seo_keywordsstring[]

SEO keywords

authorstring

Author of the article

published_atstring

ISO 8601 timestamp when article was published

blog_idsstring[]

Array of blog IDs this article belongs to

created_atstring

ISO 8601 timestamp when article was created

updated_atstring

ISO 8601 timestamp when article was last updated

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "article": {
      "id": "string",
      "title": "string",
      "excerpt": "string",
      "content": "string",
      "image": {
        "src": "string",
        "width": 0,
        "height": 0,
        "path": "string"
      },
      "published": true,
      "handle": "string",
      "seo_title": "string",
      "seo_description": "string",
      "seo_keywords": [
        "string"
      ],
      "author": "string",
      "published_at": "string",
      "blog_ids": [
        "string"
      ],
      "created_at": "string",
      "updated_at": "string"
    }
  }
}