Publishing · Blogs
Updates a blog article. Fields you leave out keep their current values. Works with Shopify, WordPress, Wix and Webflow accounts.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the publishing resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string | |
blogIdrequired | string | Matches ^[A-Za-z0-9_-]{1,64}$ |
articleIdrequired | string | Matches ^[A-Za-z0-9_-]{1,64}$ |
Request body
application/json, required
titlestringbodyHtmlstringhandlestringtagsarray of stringUp to 100 items.
authorstringexcerptstringimageobjecturlstring (URL)requiredaltTextstring
seoobjecttitlestringdescriptionstring
isPublishedbooleanpublishDatestring (date-time)fieldDataobject
Example
curl -X PATCH "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/blogs/652782a6c235ab5a16404097/articles/6c3628848bcba815158b0948" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Launch day",
"bodyHtml": "string",
"handle": "acme",
"tags": [
"string"
]
}'const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/blogs/652782a6c235ab5a16404097/articles/6c3628848bcba815158b0948", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
title: "Launch day",
bodyHtml: "string",
handle: "acme",
tags: [
"string"
]
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.patch(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/blogs/652782a6c235ab5a16404097/articles/6c3628848bcba815158b0948",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"title": "Launch day",
"bodyHtml": "string",
"handle": "acme",
"tags": [
"string",
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
platformstringOne of
shopify,wordpress,wix,webflow.articleobject17 child fields
idstringblogIdstringplatformstringOne of
shopify,wordpress,wix,webflow.titlestringbodyHtmlstringCan be null.
handlestringurlstringCan be null.
tagsarray of stringauthorstringCan be null.
excerptstringCan be null.
imageobjectCan be null.
2 child fields
urlstringaltTextstringCan be null.
isPublishedbooleanpublishedAtstring (date-time)Can be null.
statusstringOne of
publish,future,draft,pending,private.publishDatestring (date-time)Can be null.
createdAtstring (date-time)Can be null.
updatedAtstring (date-time)Can be null.
{
"platform": "shopify",
"article": {
"id": "6bfebd43ddc270f6d2c56fc5",
"blogId": "652782a6c235ab5a16404097",
"platform": "shopify",
"title": "Launch day",
"bodyHtml": "string",
"handle": "acme",
"url": "https://pozy.ai/media/example-1.jpg",
"tags": [
"string"
],
"author": "string",
"excerpt": "string",
"image": {
"url": "https://pozy.ai/media/example-1.jpg",
"altText": "Hello from Pozy"
},
"isPublished": true,
"publishedAt": "2026-10-02T09:00:00.000Z",
"status": "publish",
"publishDate": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z",
"updatedAt": "2026-10-02T09:00:00.000Z"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.