---
title: "Send test for a template"
description: "Send a back-in-stock notification template to one email address as a test, rendered against a sample alert in the body locale (omit it for the shop default language). Matches the template page's Send test email button."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-templates/send-test-for-a-template/
api: "API v2 reference"
method: POST
path: "/back_in_stock/templates/{key}/send_test"
---

# Send test for a template

`POST https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/send_test`

Send a back-in-stock notification template to one email address as a test, rendered against a sample alert in the body `locale` (omit it for the shop default language). Matches the template page's Send test email button.

**Note:** email defaults to the shop's reply-to address; one address only. shopify_variant_id and shopify_product_id (both gids, send both or neither) pick the product shown. Fails (422) when email sending is turned off for the shop.

## Path parameters

- `key` (string, required)

## 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

- `locale` (string): e.g. `fr`
- `email` (string, nullable): e.g. `shopper@example.com`
- `shopify_variant_id` (string, nullable): e.g. `45000000001`
- `shopify_product_id` (string, nullable): e.g. `78000000001`

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/templates/{key}/send_test" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "fr",
    "email": "shopper@example.com",
    "shopify_variant_id": "45000000001",
    "shopify_product_id": "78000000001"
  }'
```

## 200

Success: the updated resource.

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

## 404

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

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "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
    }
  ]
}
```