put https://{subdomain}.myshoplaza.com/openapi/2025-06/articles/
update an article
Requires
read_shop_navigationaccess scope. More access scope
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
id | string | Yes | Unique identifier for the article |
Body Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
article.title | string | Yes | "Getting Started with Shoplazza API" | Article title. |
article.excerpt | string | No | "Learn how to integrate our APIs" | Article summary/teaser text. |
article.content | string | No | "<p>Full guide content here...</p>" | Full article content. |
article.published | boolean | No | true | Whether the article is published. |
article.published_at | string | No | "2023-06-15T09:30:00Z" | Publication timestamp. |
article.handle | string | No | "getting-started-with-api" | URL-friendly article identifier. |
article.author | string | No | "Jane Smith" | Author name. |
article.seo_title | string | No | "API Integration Guide - Shoplazza" | Custom SEO title. |
article.seo_description | string | No | "Complete guide to Shoplazza API integration" | SEO meta description. |
article.seo_keywords | array | No | ["API", "integration", "ecommerce"] | SEO keywords. |
article.blog_ids | array | No | ["blog_tech", "blog_guides"] | IDs of associated blogs/collections. |
article.image.src | string | No | "https://example.com/images/api-guide.jpg" | src URL |
article.image.width | integer | No | 1200 | Image width in pixels |
article.image.height | integer | No | 800 | Image height in pixels |
Response Description
Public Response Fields
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | 200 | Status code indicating success |
message | string | "Success" | Response message |
data.article.id | string | "art_12345" | Unique identifier for the article |
data.article.title | string | "Getting Started with Shoplazza API" | Title of the article |
data.article.excerpt | string | "Learn how to integrate with Shoplazza's powerful APIs" | Short summary |
data.article.content | string | "<p>Full article content here...</p>" | Full content of the article |
data.article. image.src | string | "https://example.com/image.jpg" | src URL of article image |
data.article. image.width | integer | 800 | Image width in pixels |
data.article. image.height | integer | 600 | Image height in pixels |
data.article. image.path | string | "/uploads/articles/123.jpg" | Internal image path |
data.article.published | boolean | true | Whether the article is published or not |
data.article.handle | string | "getting-started-with-api" | URL-friendly identifier |
data.article.seo_title | string | "Shoplazza API Integration Guide" | Custom SEO title |
data.article. seo_description | string | "Learn how to integrate with Shoplazza's ecommerce APIs" | SEO meta description |
data.article. seo_keywords | array | ["API", "integration", "ecommerce"] | SEO keywords |
data.article.author | string | "John Doe" | Author of the article |
data.article. published_at | string | "2023-06-15T10:00:00Z" | Publication timestamp |
data.article.blog_ids | array | ["blog_1", "blog_2"] | Associated blog IDs |
data.article.created_at | string | "2023-06-10T08:30:00Z" | Creation timestamp |
data.article.updated_at | string | "2023-06-12T14:15:00Z" | Last update timestamp |