# Preview an order e-mail

> Renders the e-mail as it would be sent, with the store's most recent order (or a sample order).

Source: https://docs.pidgely.com/api-reference/commerce/preview-order-email/

`POST https://api.pidgely.com/commerce/stores/{id}/order-emails/{kind}/preview`

Renders the e-mail as it would be sent, with the store's most recent order (or a sample order).

**Authorization:** `Bearer pdg_…`. An API key with `full_access`. A `sending_access` key gets `401 restricted_api_key`.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `id` | string | Yes | Store id. UUID. |
| `kind` | string | Yes | One of `order_confirmation`, `payment_approved`, `order_shipped`, `order_delivered`, `order_cancelled`. |

## Request

This endpoint is not in the [SDKs](https://docs.pidgely.com/sdks/) yet; call it over HTTP.

```bash tab="cURL"
curl -X POST 'https://api.pidgely.com/commerce/stores/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21/order-emails/order_confirmation/preview' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"
```

## Response

`200 OK`

```json
{
  "from": "Acme <onboarding@acme.com>",
  "subject": "Hello from Acme",
  "html": "<p>Hello!</p>",
  "text": "Hello!"
}
```

### Response fields

| Name | Type | Required | Description |
|---|---|---|---|
| `from` | string | No | — |
| `subject` | string | Yes | Subject line, up to 998 bytes. Required unless a template provides it. |
| `html` | string | Yes | HTML body. `html` or `text` is required (unless you send with a template). |
| `text` | string | Yes | — |

## Errors

Errors have the shape `{"statusCode", "name", "message"}`. See [Errors](https://docs.pidgely.com/errors/) for the full list.

| Status | Name | When |
|---|---|---|
| 401 | `missing_api_key`, `restricted_api_key` | No `Authorization: Bearer` header, or a `sending_access` key called an endpoint that needs `full_access`. |
| 403 | `invalid_api_key`, `validation_error` | The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account). |
| 404 | `not_found` | The resource does not exist in this account (or the id is not a valid UUID). |
| 429 | `rate_limit_exceeded` | Too many requests per second. Wait for `Retry-After` seconds. |