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.

Body

application/json
enabled
boolean

Whether Win-Back writes to anybody.

firstOn
boolean

Whether the first email is sent.

firstDays
integer

Days after a buyer's last order. One of 14, 21, 30, 45, 60, 90.

Example:

30

firstSubject
string

Its subject, up to 150 characters.

secondOn
boolean

Whether the second email is sent.

secondDays
integer

Days after the first. One of 3, 7, 14, 21, 30.

Example:

14

secondSubject
string

Its subject, up to 150 characters.

secondPercent
integer

The percent off its coupon. One of 0, 5, 10, 15, 20, 25. 0 sends it with no coupon.

Example:

15

audience
string

Who is written to: empty for every subscriber, vip, or the ID of one of the store's tags.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object
meta
object