Skip to content

Notify a signup now

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

POST/back_in_stock/signups/{id}/notify

Costs 2 rate-limit points · Rate limits

Send the back-in-stock notification for one signup now, regardless of stock state, and report what happened.

The dashboard's Send / Re-send on one signup row. 202 with outcome.status "sent" or "queued" when a message went to the provider; outcome.provider names who delivers it (stoq is STOQ's own sender). 422 with the outcome when nothing was sent: status "skipped" (channel off, first alert off, no contact, channel cannot send), "blocked" (plan limit, or a provider that cannot deliver), "failed" (provider rejected) or "not_sent". 409 when the signup was already notified and allow_resend is not set.

Also searched asnotify signupsend the restock emailnotify this customersend back in stock notificationresend restock notification

Path parameters

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

  • allow_resendboolean

    Send even if the signup was already notified. Without it an already-notified signup returns 409.

    Default false

Returns

  • signup_idstring

    Id of the signup acted on.

  • outcomeobject

    What the send did.

    Show 5 child attributesHide child attributes
    • signup_idstring

      Id of the signup notified.

    • channelstring

      Channel the notification went out on (email or sms).

    • notification_idstring

      Id of the notification created; it appears in the signup's history.

    • statusstring

      sent when the provider accepted the message, queued when it is on its way to the provider.

      One of sentqueued
    • providerstring

      Who delivers it: stoq for STOQ's own sender, else the integration (klaviyo, flow, postscript).

Errors

404
not_found

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

409
conflict

The request is well formed, but the resource's current state does not allow it.

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

POST/back_in_stock/signups/{id}/notify
curl -X POST "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string/notify" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "allow_resend": false
  }'
Response
{
  "signup_id": "5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42",
  "outcome": {
    "signup_id": "5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42",
    "channel": "email",
    "notification_id": "0e9b7c2d-4a1f-4b8e-a6d3-5c2f1e8b9a70",
    "status": "queued",
    "provider": "stoq"
  }
}