Skip to content

Update alert settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

PATCH/back_in_stock/settings/alerts

Costs 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-Keystring

    A 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 (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • signups_thresholdobject

    The large-waitlist alert to the merchant.

    Show 2 child attributesHide child attributes
    • countinteger

      Waitlist threshold -- the signup count that counts as large.

    • notifyboolean

      Alert me when waitlists get large: one email per variant when its waitlist reaches the waitlist threshold, sent to 'Email address to receive reports'.

  • signup_alertsobject

    The every-signup alert to the merchant.

    Show 2 child attributesHide child attributes
    • enabledboolean

      Alert me for every signup: one email per signup, sent to 'Email address to receive alerts'.

    • emailstring

      Where the every-signup alert goes. Used only while 'Alert me for every signup' is on.

  • scheduled_reportsobject

    Daily, weekly and monthly usage report emails and where they go.

    Show 4 child attributesHide child attributes
    • dailyboolean

      Send the back-in-stock and preorder usage report daily.

    • weeklyboolean

      Send that usage report weekly.

    • monthlyboolean

      Send that usage report monthly.

    • emailstring

      Email 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_sentboolean

    Notify me when back-in-stock alerts are sent. Sent to 'Email address to receive reports'.

  • merchant_emailsobject

    Which of STOQ's own emails the merchant receives.

    Show 2 child attributesHide child attributes
    • product_updatesboolean

      Email the merchant about STOQ's new features and updates.

    • theme_publishedboolean

      Email the merchant when a theme is published, to check the widget still shows.

Returns

  • signups_thresholdobject
    Show 2 child attributesHide child attributes
    • countinteger
      Example: 25
    • notifyboolean
      Example: true
  • signup_alertsobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: false
    • emailnull
  • scheduled_reportsobject
    Show 4 child attributesHide child attributes
    • dailyboolean
      Example: false
    • weeklyboolean
      Example: true
    • monthlyboolean
      Example: false
    • emailnull
      Example: ops@example.com
  • notify_on_alert_sentboolean
    Example: true
  • merchant_emailsobject
    Show 2 child attributesHide child attributes
    • product_updatesboolean
      Example: true
    • theme_publishedboolean
      Example: true

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_option

An integration option, such as a Mailchimp list id, was rejected.

422
invalid_params

One or more fields failed the action's schema.

422
unmapped_settings

The request named settings this action cannot write.

422
validation_failed

The 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.

PATCH/back_in_stock/settings/alerts
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"
    }
  }'
Response
{
  "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
  }
}