Update Blog Post

PUT 
/blogs/posts/:postId

The "Update Blog Post" API updates an existing blog post for any given blog site.

Request

Version stringrequired

API Version

Available optionsv3

postId stringrequired

Identifier of the blog post to fetch

application/json

application/json

Body

Bodyrequired

titlestring

Title of the blog post

locationIdstringrequired

Sub-account (location) identifier the blog post belongs to

blogIdstringrequired

Identifier of the blog site the post belongs to

imageUrlstring

Cover image URL for the blog post

descriptionstring

Short description or excerpt for the blog post

rawHTMLstringrequired

Full HTML body of the blog post

statusstringrequired
Publication status of the blog post
Available optionsDRAFTPUBLISHEDSCHEDULEDARCHIVEDDELETED
wordCountnumber

Total word count of the blog post body

readTimeInMinutesnumber

Estimated read time of the blog post, in minutes

archivedboolean

Whether the blog post is archived

imageAltTextstring

Alt text for the cover image

currentVersionstring

Identifier of the current version of the blog post

metaDataobject

Metadata about actors that performed lifecycle actions on the post

categoriesstring[]

Identifiers of categories the blog post belongs to

tagsstring[]

Tags applied to the blog post

authorstring

Identifier of the author of the blog post

urlSlugstring

URL-safe slug used in the blog post path

canonicalLinkstring

Canonical link override for SEO

importIdstring

Identifier of the import record this post was created from

typestring

Post type marker (e.g., "preview")

publishedAtstring

Timestamp when the post was (or will be) published

scheduledAtstring<date-time>

Timestamp when the post is scheduled to publish

externalFontsstring[]

External fonts referenced by the blog post body

originIdstring

External identifier when the post was imported from another system

tocStylestring

Table-of-contents style preference for the post

isAutoSaveboolean

Whether this update is an automatic save from the editor

conversationHistoryPathstring

Storage path of the conversation history for AI-assisted edits

assistModeDataobject

Assist-mode configuration captured at the time of generation

isAiGeneratedboolean

Whether the blog post was generated using AI assistance

isAIGeneratedbooleandeprecated

Deprecated. Use isAiGenerated instead. Kept for backwards compatibility.

Example (auto)

{
  "title": "My Blog Post",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "blogId": "lMOzIQZne5m6zQ528sT6",
  "imageUrl": "https://storage.googleapis.com/blog-assets/posts/cover.png",
  "description": "A practical guide to inbound marketing in 2026.",
  "rawHTML": "<h1>Hello</h1><p>This is my post.</p>",
  "status": "DRAFT",
  "wordCount": 1200,
  "readTimeInMinutes": 6,
  "archived": false,
  "imageAltText": "A laptop on a desk",
  "currentVersion": "66c381b38be80858b9af62b7",
  "metaData": {
    "updatedBy": "user_abc123",
    "publishedBy": "user_abc123"
  },
  "categories": [
    "659ecabc4a37969a2b7cc370"
  ],
  "tags": [
    "marketing",
    "seo"
  ],
  "author": "659ec9634a3796e4e47cc360",
  "urlSlug": "my-blog-post",
  "canonicalLink": "https://example.com/blog/my-blog-post",
  "importId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "type": "preview",
  "publishedAt": "2026-05-13T17:14:57.000Z",
  "scheduledAt": "2026-06-01T09:00:00.000Z",
  "externalFonts": [
    "Inter",
    "Merriweather"
  ],
  "originId": "wp-post-42",
  "tocStyle": "sidebar",
  "isAutoSave": false,
  "conversationHistoryPath": "conversations/blog/64a1b2c3d4e5f6a7b8c9d0e1.json",
  "assistModeData": {
    "topic": "How to improve customer engagement using AI",
    "wordLimit": "1000-1500",
    "tone": "professional"
  },
  "isAiGenerated": false
}

application/json

Successful response

application/json

Schema

Schema

updatedBlogPostobjectrequired

Object containing response data of blog post update

Example (auto)

{
  "updatedBlogPost": {
    "_id": "66c381b38be80858b9af62b6",
    "title": "How to grow your agency",
    "status": "PUBLISHED"
  }
}