---
title: "Notify variant waitlists"
description: "Send back-in-stock notifications to everyone waiting on up to 10 variants, as the products table's Send notifications bulk action does."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-signups/notify-variant-waitlists/
api: "API v2 reference"
method: POST
path: "/back_in_stock/signups/notify_variants"
---

# Notify variant waitlists

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

Send back-in-stock notifications to everyone waiting on up to 10 variants, as the products table's Send notifications bulk action does.

**Note:** Sends to pending signups only, on every channel, regardless of stock. A variant whose channel cannot send (plan limit, channel off, awaiting review, or a provider that cannot deliver) is skipped and its reason listed in errors; the others still send. 202 with one send per variant queued (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/)) and providers per channel. 422 when nothing was 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

- `shopify_variant_ids` (array of strings, required): Shopify variant gids whose pending signups to notify, up to 10.

## 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` (null): 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).
- `errors` (array of anys): Why a variant was skipped, one message each (plan limit, channel off, awaiting review, or a provider that cannot deliver). The other variants still send.

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_variants" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_ids": [
      "gid://shopify/ProductVariant/47284734423096",
      "gid://shopify/ProductVariant/47284734455864"
    ]
  }'
```

## 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": null,
      "status": "pending",
      "limit": 42,
      "signups_count": 42,
      "sent_count": 0,
      "created_at": "2026-06-25T14:02:11Z"
    }
  ],
  "providers": {
    "email": "stoq",
    "sms": "stoq"
  },
  "errors": []
}
```

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

