Skip to main content
POST
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.

Body

application/json
title
string
required

Its title, up to 100 characters.

Example:

"New stock on Friday"

body
string
required

What it says, up to 1,000 characters.

pinned
boolean
default:false

Whether it is shown first, before the newer ones.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object
meta
object