---
title: "Notify signups"
description: "Send back-in-stock notifications to every signup matching the waitlist filters, or only the first N, as the dashboard's Send notifications and Re-send all buttons do."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-signups/notify-signups/
api: "API v2 reference"
method: POST
path: "/back_in_stock/signups/notify"
---

# Notify signups

`POST https://app.stoqapp.com/api/v2/external/back_in_stock/signups/notify`

Send back-in-stock notifications to every signup matching the waitlist filters, or only the first N, as the dashboard's Send notifications and Re-send all buttons do.

**Note:** status is pending (not notified yet) or notified; from/to are shop-local days matched against the signup date for pending and the notified date for notified. title and sku match the product title or SKU. without_orders keeps notified signups that led to no order. status pending sends to signups not notified yet; status notified re-sends to signups already notified, oldest notification first when limit is set. channel sends only email or only sms. Sends regardless of stock. 202 with one send per variant: its id is the job id for [`GET /back_in_stock/sending_history/:id`](https://docs.stoqapp.com/v2-reference/back-in-stock-sending-history/retrieve-the-sending-history-get-back-in-stock-sending-history-id/). providers names who delivers each channel (stoq is STOQ's own sender). 422 when no signup matches, or a channel cannot send (plan limit, channel off, awaiting review, or a provider that cannot deliver), and nothing is queued.

## Headers

- `Idempotency-Key` (string): 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

- `status` (string) One of: `pending`, `notified`.
- `shopify_market_ids` (array of strings)
- `channel` (string): e.g. `email` One of: `email`, `sms`.
- `limit` (integer)
- `shopify_product_id` (any)
- `shopify_variant_id` (string): e.g. `gid://shopify/ProductVariant/47284734423096`
- `customer_id` (any)
- `title` (any)
- `sku` (any)
- `without_orders` (any)
- `from` (any)
- `to` (any)

## Returns

- `sends` (array of objects)
  - `id` (string): e.g. `c3e8a1f4-7b2d-4e9a-8c51-0f6d2b9e7a13`
  - `shopify_product_id` (string): e.g. `gid://shopify/Product/8784906035384`
  - `shopify_variant_id` (string): e.g. `gid://shopify/ProductVariant/47284734423096`
  - `product_title` (string): e.g. `Trail Shoe`
  - `variant_title` (string): e.g. `Blue / Medium`
  - `shopify_location_id` (any)
  - `source` (string): e.g. `bulk_send`
  - `channel` (string): e.g. `email`
  - `status` (string): e.g. `pending`
  - `limit` (integer): e.g. `42`
  - `signups_count` (integer): e.g. `42`
  - `sent_count` (integer): e.g. `0`
  - `created_at` (string): e.g. `2026-06-25T14:02:11Z`
- `providers` (object)
  - `email` (string): e.g. `stoq`

Rate limit: this call costs 2 points ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl -X POST "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/notify" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
    "channel": "email"
  }'
```

## 200

Success: example response shown.

```json
{
  "sends": [
    {
      "id": "c3e8a1f4-7b2d-4e9a-8c51-0f6d2b9e7a13",
      "shopify_product_id": "gid://shopify/Product/8784906035384",
      "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
      "product_title": "Trail Shoe",
      "variant_title": "Blue / Medium",
      "shopify_location_id": null,
      "source": "bulk_send",
      "channel": "email",
      "status": "pending",
      "limit": 42,
      "signups_count": 42,
      "sent_count": 0,
      "created_at": "2026-06-25T14:02:11Z"
    }
  ],
  "providers": {
    "email": "stoq"
  }
}
```

## 202

Accepted: async/bulk work was queued. Poll the returned job.

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

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 409

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

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

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

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

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```