---
title: "Bulk 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/bulk-notify-signups/
api: "API v2 reference"
method: POST
path: "/back_in_stock/signups/notify"
---

# Bulk 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/get-a-sends-progress/). 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): Send to signups not notified yet (pending) or re-send to signups already notified. Default pending. One of: `pending`, `notified`.
- `shopify_market_ids` (array of strings): Only signups from these Shopify markets, as gids.
- `without_orders` (boolean, nullable): When true, only notified signups that led to no order. Ignored for pending signups.
- `channel` (string): Send on this channel only. Default both. One of: `email`, `sms`.
- `limit` (integer): Send to at most this many matching signups. Default all of them.
- `shopify_product_id` (string): Only signups for this Shopify product, as a gid.
- `shopify_variant_id` (string): Only signups for this Shopify variant, as a gid.
- `customer_id` (string): Only signups of this customer, by STOQ customer id.
- `title` (string): Only signups whose product title or SKU contains this text.
- `sku` (string): Only signups whose product title or SKU contains this text.
- `from` (string): First day, in the shop's time zone, of the signup date (pending) or notified date (notified).
- `to` (string): Last day, in the shop's time zone, of the signup date (pending) or notified date (notified). Default today when from is given.

## Returns

- `sends` (array of objects): One queued send per variant; follow each with GET /back_in_stock/sending_history/:id.
  - `id` (string): Send id; also the job id for GET /back_in_stock/sending_history/:id.
  - `shopify_product_id` (string): Shopify product gid of the variant being notified.
  - `shopify_variant_id` (string): Shopify variant gid whose waitlist this send works through.
  - `product_title` (string): Product title; null when the variant is not synced.
  - `variant_title` (string): Variant title; null for a product's only (default) variant or when the variant is not synced.
  - `shopify_location_id` (null): Shopify location gid of the restock that started the send; null for manual sends.
  - `source` (string): What started the send: bulk_send and bulk_resend are sends from the dashboard or API; webhook, events_inventory, events_products and reconciliation are detected restocks; flow_action is Shopify Flow. One of: `webhook`, `bulk_send`, `bulk_resend`, `flow_action`, `events_inventory`, `events_products`, `reconciliation`.
  - `channel` (string, nullable): Only signups on this channel (email or sms) are sent; null means every channel.
  - `status` (string): active is sending, waiting is paused between batches, completed is done. One of: `active`, `waiting`, `completed`.
  - `limit` (integer): Most signups this send notifies; null means the whole waitlist.
  - `signups_count` (integer): Signups attached to this send so far.
  - `sent_count` (integer): Notifications this send has created so far; with signups_count, its progress.
  - `created_at` (string): When the send was queued (ISO 8601).
- `providers` (object): Who delivers each channel being sent, keyed by channel.
  - `email` (string): Email sender: stoq for STOQ's own sender, else the integration (klaviyo, flow).

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

## Examples

### Email a variant's whole waitlist

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

Response:

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

### Text the first 20 people waiting

`limit` caps the send at the first 20 matching signups; the rest stay on the waitlist.

```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": "sms",
    "limit": 20
  }'
```

Response:

```json
{
  "sends": [
    {
      "id": "7d2f9b4e-1a6c-4e83-b5d0-2c8a6f1e9b37",
      "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": "sms",
      "status": "pending",
      "limit": 20,
      "signups_count": 20,
      "sent_count": 0,
      "created_at": "2026-06-25T14:05:47Z"
    }
  ],
  "providers": {
    "sms": "stoq"
  }
}
```

### Re-send to signups who didn't order

`status: notified` with `without_orders` re-sends to shoppers who were notified but haven't bought.

```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",
    "status": "notified",
    "without_orders": true,
    "channel": "email"
  }'
```

Response:

```json
{
  "sends": [
    {
      "id": "e5a1c7d3-9b2f-4d60-8a4e-6f3b1d9c2e05",
      "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": 15,
      "signups_count": 15,
      "sent_count": 0,
      "created_at": "2026-06-26T09:30:02Z"
    }
  ],
  "providers": {
    "email": "stoq"
  }
}
```

## 202

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

## 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
    }
  ]
}
```

