---
title: "Get confirmation email"
description: "Read the preorder confirmation notification's email and SMS copy. ?locale= picks the language (omit it for the shop default); the response names it in locale. Whether it sends is GET /preorders/notification_settings/conf"
url: https://docs.stoqapp.com/v2-reference/preorders-templates/get-confirmation-email/
api: "API v2 reference"
method: GET
path: "/preorders/templates/confirmation"
---

# Get confirmation email

`GET https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation`

Read the preorder confirmation notification's email and SMS copy. ?locale= picks the language (omit it for the shop default); the response names it in `locale`. Whether it sends is [`GET /preorders/notification_settings/confirmation`](https://docs.stoqapp.com/v2-reference/preorders-notification-settings/get-confirmation-settings/).

**Note:** Change the copy with [`PATCH /preorders/templates/confirmation`](https://docs.stoqapp.com/v2-reference/preorders-templates/update-confirmation-email/). The copy uses Liquid variables such as {{order.name}} and {{shop.name}}. A language with no translation of a field returns the shop default's text for it. `integration` is set when the shop sends that channel through Klaviyo, Postscript or Shopify Flow, and klaviyo_flow_name is the Klaviyo flow it uses then. 404 `not_found` when the shop has no single preorder confirmation template.

## Query parameters

- `locale` (string): Language of the copy, such as fr or pt-BR. Omit for the shop's default language.

## Returns

- `key` (string): e.g. `string`
- `locale` (string): e.g. `string`
- `email` (object)
  - `subject` (string): e.g. `string`
  - `preheader` (null)
  - `heading` (string): e.g. `string`
  - `body` (string): e.g. `string`
  - `footer` (string): e.g. `string`
  - `button` (object)
    - `text` (string): e.g. `string`
    - `background_color` (string): e.g. `string`
    - `text_color` (string): e.g. `string`
    - `radius` (integer): e.g. `1`
  - `colors` (object)
    - `background` (string): e.g. `string`
    - `section` (string): e.g. `string`
    - `text` (string): e.g. `string`
  - `radius` (integer): e.g. `1`
  - `css` (null)
  - `reviews` (object)
    - `enabled` (boolean): e.g. `true`
    - `count` (integer): e.g. `1`
    - `min_rating` (integer): e.g. `1`
    - `title` (string): e.g. `string`
  - `social` (object)
    - `facebook` (null)
    - `instagram` (null)
    - `pinterest` (null)
    - `twitter` (null)
    - `tiktok` (null)
    - `whatsapp` (null)
    - `youtube` (null)
    - `icon_color` (string): e.g. `string`
  - `klaviyo_flow_name` (string, nullable): e.g. `string`
  - `klaviyo_flow_verified` (boolean): e.g. `true`
  - `integration` (null)
- `sms` (object)
  - `body` (string): e.g. `string`
  - `klaviyo_flow_name` (string, nullable): e.g. `string`
  - `klaviyo_flow_verified` (boolean): e.g. `true`
  - `postscript_flow_verified` (boolean): e.g. `true`
  - `integration` (null)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Get confirmation email

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get confirmation email filtered by locale

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation?locale=fr" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "key": "string",
  "locale": "string",
  "email": {
    "subject": "string",
    "preheader": null,
    "heading": "string",
    "body": "string",
    "footer": "string",
    "button": {
      "text": "string",
      "background_color": "string",
      "text_color": "string",
      "radius": 1
    },
    "colors": {
      "background": "string",
      "section": "string",
      "text": "string"
    },
    "radius": 1,
    "css": null,
    "reviews": {
      "enabled": true,
      "count": 1,
      "min_rating": 1,
      "title": "string"
    },
    "social": {
      "facebook": null,
      "instagram": null,
      "pinterest": null,
      "twitter": null,
      "tiktok": null,
      "whatsapp": null,
      "youtube": null,
      "icon_color": "string"
    },
    "klaviyo_flow_name": "string",
    "klaviyo_flow_verified": true,
    "integration": null
  },
  "sms": {
    "body": "string",
    "klaviyo_flow_name": "string",
    "klaviyo_flow_verified": true,
    "postscript_flow_verified": true,
    "integration": null
  }
}
```

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

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

