Notify a signup

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

idstringRequired

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
Example: false

Returns

signup_idstring
Example: 5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42
outcomeobject
Show 5 child attributesHide child attributes
- signup_idstring
  Example: 5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42
- channelstring
  Example: email
- notification_idstring
  Example: 0e9b7c2d-4a1f-4b8e-a6d3-5c2f1e8b9a70
- statusstring
  Example: queued
- providerstring
  Example: stoq

Errors

401

Missing or invalid X-Auth-Token.

404

The resource does not exist for this shop, or the action path is not registered.

409

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

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

POST/back_in_stock/signups/{id}/notify

curl -X POST "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/{id}/notify" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "allow_resend": false
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/{id}/notify", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "allow_resend": false
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/{id}/notify",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "allow_resend": False
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/{id}/notify")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  allow_resend: false
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

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"
  }
}

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

{
  "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
    }
  ]
}