---
title: "Send a test email"
description: "Send a preview of the download email to the merchant (to; default the shop's email), built from one of the shop's own orders, as the email settings page's Send test email does."
url: https://docs.filemonk.io/v2/api-reference/settings/send-a-test-email/
api: "API v2 reference"
method: POST
path: "/settings/test_email"
---

# Send a test email

`POST https://app.filemonk.io/api/v2/external/settings/test_email`

Send a preview of the download email to the merchant (to; default the shop's email), built from one of the shop's own orders, as the email settings page's Send test email does.

**Note:** Nothing is charged and no order changes. 422 when the shop has no order to build the preview from; 409 when the shop's email sending is blocked.

## Request body

- `to` (string): e.g. `owner@example.com`

## Returns

- `sent` (boolean, nullable, required): e.g. `true`
- `to` (string, nullable, required): e.g. `owner@example.com`

Rate limit: this call costs 2 points ([rate limits](https://docs.filemonk.io/v2/errors-and-rate-limits/)).

## Example request

```sh
curl -X POST "https://app.filemonk.io/api/v2/external/settings/test_email" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "owner@example.com"
  }'
```

## 200

Success: the write completed; the body is the updated resource.

```json
{
  "sent": true,
  "to": "owner@example.com"
}
```

## 401

Missing or invalid API key.

```json
{
  "errors": [
    "Invalid API key"
  ]
}
```

## 409

The request conflicts with the current state (an order Shopify is not ready to fulfil, a digital product that already exists). Nothing was changed; read the message, don't retry blindly.

```json
{
  "errors": [
    "This product already has a digital product"
  ]
}
```

## 422

The request failed validation, or sent a key the action does not take (`code: "unknown_parameters"` with `unknown` and `accepted`). Nothing was saved.

```json
{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}
```

## 429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` (Unix time the window ends); a 429 adds `Retry-After` (seconds), `retry_after`, `retryable: true` and a `next_step` in the body. A 429 did nothing: wait `retry_after` seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with `per_page` over many single reads.

```json
{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}
```

## 502

Shopify (or the email service) did not complete the request. Nothing was changed; try again shortly.

```json
{
  "errors": [
    "Shopify did not complete the request. Nothing was changed; try again shortly."
  ],
  "code": "shopify_error"
}
```