Skip to main content
PUT
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key
string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

postId
string
required

The post.

Body

application/json
title
string
required

Its title.

slug
string

The last part of its address. Left out, it is made from the title.

body
string

The post's text, as Markdown.

status
enum<string>

A draft is nowhere on the store. A published post is.

Available options:
draft,
published
categoryId
string

The blog category it is in. A post moved to another category is counted there as a new one.

coverAlt
string

What its cover picture shows, for readers who cannot see it.

seoTitle
string

Its own title in search results. Empty is its title.

seoDescription
string

Its own description in search results. Empty is the start of its text.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object