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.

ruleId
string
required

The rule.

Body

application/json
type
enum<string>
required

What the rule matches: an email address, an email domain, an IP address, a range of them (cidr), a network by its number (asn) or its provider's name (isp), or a city. Countries are blocked in the settings instead.

Available options:
email,
domain,
ip,
cidr,
asn,
isp,
city
value
string
required

What to match.

Example:

"mailinator.com"

note
string

Why, up to 500 characters.

enabled
boolean
default:true

Whether the rule is in force.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object