Skip to main content
POST
Create a blog post
Creates a blog post; a unique slug is generated from the title and publishedAt is set when the post is created as published. The owning store and author are set server-side — never send a shop id.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json

Fields accepted when creating a blog post.

title
string
required

Post title (max 200 characters). Used to generate the slug.

Maximum string length: 200
content
string
required

Post body (HTML or rich text).

description
string
default:""

Short summary/excerpt (max 500 characters). Defaults to empty string.

Maximum string length: 500
image
string
default:""

Cover image URL. Defaults to empty string.

tags
string[]

Array of tag strings. Defaults to empty array.

published
boolean
default:false

Whether the post is published. Defaults to false (draft).

Response

The created blog post.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A store-scoped blog post with its author populated.