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
name
string

What the link is called on the dashboard, up to 60 characters. Resellers never see it. Needed to make one.

Example:

"Discord partners"

tierId
string

The tier whoever joins through it starts in. Empty or left out, none: they pay the Reseller Price.

maxUses
integer

How many may join through it, 1 to 100,000. Empty or left out, no limit.

endsAt
string

When it stops working, as a date and time. Empty or left out, never.

Example:

"2026-12-31T23:59:00Z"

enabled
boolean
default:true

Whether it works.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object
meta
object