Update alert settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/settings/alertsCosts 2 rate-limit points · Rate limits
Update back-in-stock merchant alert and scheduled report settings.
Toggles set via this PATCH: signups_threshold.notify, signup_alerts.enabled, scheduled_reports.daily, scheduled_reports.weekly, scheduled_reports.monthly, notify_on_alert_sent: e.g. { scheduled_reports: { weekly: true } }. signups_threshold.count is the per-variant signup count that triggers the high-demand merchant alert email. signup_alerts.enabled turns on an immediate email to the merchant for every individual signup, sent to signup_alerts.email. scheduled_reports.email is the address that receives the daily/weekly/monthly summary reports. notify_on_alert_sent emails the merchant whenever back-in-stock alerts are sent to customers. merchant_emails.product_updates and merchant_emails.theme_published turn STOQ's own emails to the merchant on or off.
Also searched asedit alert settingschange alert settingsset signup thresholdnotify me on high demandenable signup threshold alertsdisable signup threshold alertsalert me when a product gets lots of signupsenable daily reportenable weekly reportenable monthly reportdisable daily reportdisable weekly reportdisable monthly reportschedule reportsturn off report emailsstop feature update emailsnotify me when a theme is published
Headers
Idempotency-KeystringA fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with
Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
signups_thresholdobjectThe large-waitlist alert to the merchant.
Show 2 child attributesHide child attributes
countintegerWaitlist threshold -- the signup count that counts as large.
notifybooleanAlert me when waitlists get large: one email per variant when its waitlist reaches the waitlist threshold, sent to 'Email address to receive reports'.
signup_alertsobjectThe every-signup alert to the merchant.
Show 2 child attributesHide child attributes
enabledbooleanAlert me for every signup: one email per signup, sent to 'Email address to receive alerts'.
emailstringWhere the every-signup alert goes. Used only while 'Alert me for every signup' is on.
scheduled_reportsobjectDaily, weekly and monthly usage report emails and where they go.
Show 4 child attributesHide child attributes
dailybooleanSend the back-in-stock and preorder usage report daily.
weeklybooleanSend that usage report weekly.
monthlybooleanSend that usage report monthly.
emailstringEmail address to receive reports. Also receives the waitlist-threshold alert, the alerts-sent email, plan-limit warnings, payment-collection results and other STOQ emails to the merchant.
notify_on_alert_sentbooleanNotify me when back-in-stock alerts are sent. Sent to 'Email address to receive reports'.
merchant_emailsobjectWhich of STOQ's own emails the merchant receives.
Show 2 child attributesHide child attributes
product_updatesbooleanEmail the merchant about STOQ's new features and updates.
theme_publishedbooleanEmail the merchant when a theme is published, to check the widget still shows.
Returns
signups_thresholdobjectShow 2 child attributesHide child attributes
countintegerExample:25notifybooleanExample:true
signup_alertsobjectShow 2 child attributesHide child attributes
enabledbooleanExample:falseemailnull
scheduled_reportsobjectShow 4 child attributesHide child attributes
dailybooleanExample:falseweeklybooleanExample:truemonthlybooleanExample:falseemailnullExample:ops@example.com
notify_on_alert_sentbooleanExample:truemerchant_emailsobjectShow 2 child attributesHide child attributes
product_updatesbooleanExample:truetheme_publishedbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_optionAn integration option, such as a Mailchimp list id, was rejected.
invalid_paramsOne or more fields failed the action's schema.
unmapped_settingsThe request named settings this action cannot write.
validation_failedThe action refused the request for a reason that is not a single bad field.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl -X PATCH "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"signups_threshold": {
"count": 25,
"notify": true
},
"scheduled_reports": {
"weekly": true,
"email": "ops@example.com"
}
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"signups_threshold": {
"count": 25,
"notify": true
},
"scheduled_reports": {
"weekly": true,
"email": "ops@example.com"
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"signups_threshold": {
"count": 25,
"notify": True
},
"scheduled_reports": {
"weekly": True,
"email": "ops@example.com"
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
signups_threshold: {
count: 25,
notify: true
},
scheduled_reports: {
weekly: true,
email: "ops@example.com"
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"signups_threshold": {
"count": 25,
"notify": true
},
"signup_alerts": {
"enabled": false,
"email": null
},
"scheduled_reports": {
"daily": false,
"weekly": true,
"monthly": false,
"email": "ops@example.com"
},
"notify_on_alert_sent": true,
"merchant_emails": {
"product_updates": true,
"theme_published": true
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"A request with this Idempotency-Key is still running"
],
"code": "idempotency_key_in_progress",
"details": [
{
"code": "idempotency_key_in_progress",
"message": "A request with this Idempotency-Key is still running",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}