Skip to content

Update a notification

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

PATCH/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

  • keystringRequired

    Which notification: signup_thank_you, restock_alert or reminder.

    One of signup_thank_yourestock_alertreminder

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

  • enabledboolean

    Whether this notification sends. For restock_alert it is the "Send automatic notification" switch: false stops automatic back-in-stock alerts.

  • after_n_daysinteger

    Days to wait after the restock alert before the reminder sends. Reminder only.

Returns

The notification setting object.

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_params

One or more fields failed the action's schema.

422
validation_failed

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

PATCH/back_in_stock/notification_settings/{key}
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
  }'
Response
{
  "key": "reminder",
  "enabled": true,
  "after_n_days": 3
}