Update a notification
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/notification_settings/{key}Costs 2 rate-limit points · Rate limits
Turn a back-in-stock notification on or off, or change when the reminder sends. key is "signup_thank_you", "restock_alert" or "reminder". enabled (true/false) works on every key; for "restock_alert" it is the Notifications card's "Send automatic notification" switch, so false stops automatic back-in-stock alerts. after_n_days (1 or more) is the reminder's wait after the restock alert.
Partial. after_n_days is only accepted for the reminder. Errors are 422 keyed "notification_setting.<field>".
Also searched aschange reminder timingsend the reminder after 3 daysturn on the restock reminderturn off the restock reminderturn off automatic back in stock alertsstop sending restock alertsenable signup thank you emailturn off signup thank you email
Path parameters
keystringRequiredWhich notification: signup_thank_you, restock_alert or reminder.
One ofsignup_thank_yourestock_alertreminder
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
enabledbooleanWhether this notification sends. For restock_alert it is the "Send automatic notification" switch: false stops automatic back-in-stock alerts.
after_n_daysintegerDays to wait after the restock alert before the reminder sends. Reminder only.
Returns
The notification setting object.
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_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
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/notification_settings/{key}" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"after_n_days": 3
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"after_n_days": 3
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"after_n_days": 3
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
after_n_days: 3
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"key": "reminder",
"enabled": true,
"after_n_days": 3
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"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
}
]
}