---
title: "Create a signup"
description: "Add a customer to a variant's back-in-stock waitlist, as the dashboard's Add signup page does."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-signups/create-a-signup/
api: "API v2 reference"
method: POST
path: "/back_in_stock/signups"
---

# Create a signup

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

Add a customer to a variant's back-in-stock waitlist, as the dashboard's Add signup page does.

**Note:** Give email, phone or both: each one becomes its own signup (email channel, sms channel), and a channel that is turned off is skipped with a message in errors. shopify_product_id is read from the variant when omitted. 409 when a pending signup already exists for that contact and variant.

## 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_id` (string, required): e.g. `gid://shopify/ProductVariant/47284734423096`
- `quantity` (integer): e.g. `2`
- `accepts_marketing` (boolean)
- `shopify_product_id` (any)
- `email` (string): e.g. `john@example.com`
- `phone` (any)
- `name` (string): e.g. `John Doe`
- `shopify_market_id` (any)

## Returns

- `signups` (array of objects)
  - `id` (string): e.g. `5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42`
  - `channel` (string): e.g. `email`
  - `contact` (string): e.g. `john@example.com`
  - `quantity` (integer): e.g. `2`
  - `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`
  - `sku` (string): e.g. `TS-BLU-M`
  - `shopify_market_id` (any)
  - `customer_id` (string): e.g. `8b6f1e2a-0c4d-4f7a-b1e3-9d2c5a7f6e10`
  - `customer_name` (string): e.g. `John Doe`
  - `accepts_marketing` (boolean): e.g. `false`
  - `customer_unsubscribed_at` (any)
  - `customer_bounce_count` (integer): e.g. `0`
  - `optin_confirmed` (any)
  - `unsubscribed_at` (any)
  - `notifications_count` (integer): e.g. `0`
  - `notified_at` (any)
  - `created_at` (string): e.g. `2026-06-25T13:45:30Z`
- `errors` (object)

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" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
    "email": "john@example.com",
    "quantity": 2,
    "name": "John Doe"
  }'
```

## 200

Success: example response shown.

```json
{
  "signups": [
    {
      "id": "5f0c2a9e-3b1d-4c8e-9a51-2d7e6b1f0a42",
      "channel": "email",
      "contact": "john@example.com",
      "quantity": 2,
      "shopify_product_id": "gid://shopify/Product/8784906035384",
      "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
      "product_title": "Trail Shoe",
      "variant_title": "Blue / Medium",
      "sku": "TS-BLU-M",
      "shopify_market_id": null,
      "customer_id": "8b6f1e2a-0c4d-4f7a-b1e3-9d2c5a7f6e10",
      "customer_name": "John Doe",
      "accepts_marketing": false,
      "customer_unsubscribed_at": null,
      "customer_bounce_count": 0,
      "optin_confirmed": null,
      "unsubscribed_at": null,
      "notifications_count": 0,
      "notified_at": null,
      "created_at": "2026-06-25T13:45:30Z"
    }
  ],
  "errors": {}
}
```

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