Skip to main content
POST
blog.post.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
blogId
string
required

The blog the post is in, from blog.sites.list.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]{1,64}$
postId
string
required

The post to update, from blog.posts.list.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]{1,64}$
accountId
string

The connected store or site the post is on, from social.accounts.list. Omit when exactly one is connected.

Required string length: 1 - 256
fields
object

Custom CMS collection fields keyed by slug. Supported by collection-based sites only; standard mapped fields cannot be overridden.

title
string

New post title.

Required string length: 1 - 512
body
string

New post body as HTML, up to 500000 characters, passed to the platform exactly as given. Replaces the old body.

Required string length: 1 - 500000
handle
string

New URL slug.

Required string length: 1 - 512
tags
string[]

Replaces the full tag-name list. Existing names are matched case-insensitively; missing ones are created. Up to 100.

Maximum array length: 100
Required string length: 1 - 255
author
string

Author display name, or the site author's id as a string.

Required string length: 1 - 255
excerpt
string

Short summary shown in blog listings.

Required string length: 1 - 2048
image
object

New featured image, given by URL.

seo
object

Search-engine overrides. Only some stores take these; sites refuse them.

publishAt
string

New schedule: publish natively at this future ISO 8601 time. Omit to leave the schedule as it is.

Response

The result

postId
string
required

Pass back as postId to the other blog.post.* capabilities.

blogId
string
required

The blog the post is in; pass back as blogId.

platform
string
required

Lowercase platform name of the connected account.

title
string
required

Post title.

isPublished
boolean
required

False while the post is a draft or its publish time is still in the future.

body
string

The body exactly as the platform stores it (HTML, or what was sent).

handle
string

URL slug of the post.

tags
string[]

Tag names.

author
string

Author display name, or the site author's id as a string.

excerpt
string

Short summary shown in blog listings.

image
object

Featured image.

publishedAt
string

When the post went live, ISO 8601; absent for drafts and scheduled posts.

status
string

Platform-native status on a site (publish, future, draft, pending, private).

scheduledAt
string

Scheduled publish time, ISO 8601, while the post is still waiting to go out.

createdAt
string

Creation time, ISO 8601, when the platform reports one.

updatedAt
string

Last modification time, ISO 8601.