---
title: "Update payment failed"
description: "Update the payment-failed email STOQ sends when the remaining balance of a partially paid preorder cannot be charged: its subject, heading, body, button text and optional Klaviyo flow. The body is the GET shape, email{.."
url: https://docs.stoqapp.com/v2-reference/preorders-templates/update-payment-failed/
api: "API v2 reference"
method: PATCH
path: "/preorders/templates/payment_failed"
---

# Update payment failed

`PATCH https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed`

Update the payment-failed email STOQ sends when the remaining balance of a partially paid preorder cannot be charged: its subject, heading, body, button text and optional Klaviyo flow. The body is the GET shape, email{...}; an optional body `locale` writes the copy in that language only (omit it for the shop default).

**Note:** Deep partial: absent fields are unchanged, unknown or read-only keys are rejected. Errors are 422 keyed "template.<path>". Returns the template.

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

- `email` (object)
  - `subject` (string): Email subject of the payment-failed email, sent when the remaining balance of a partially paid preorder cannot be charged.
  - `heading` (string): Heading at the top of the payment-failed email.
  - `body` (string): Message body of the payment-failed email.
  - `button_text` (string): Text of the button that takes the customer to complete the payment.
  - `klaviyo_flow_name` (string): Klaviyo flow to trigger when a preorder payment fails, instead of sending the email here. Only used while the email platform is Klaviyo.
- `locale` (string): Language the translated fields are written in, such as 'fr' or 'pt-BR'. Omitted: the shop's default language. Untranslated fields ignore it.

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

## Example request

```sh
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": {
      "subject": "string",
      "heading": "string",
      "body": "string",
      "button_text": "Preorder now",
      "klaviyo_flow_name": "Summer Sneaker Drop"
    },
    "locale": "fr"
  }'
```

## 200

Success: the updated resource.

## 202

Saved. Returns the updated section, with also_changed for cascades.

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

Invalid fields: one `details` entry per field error, its `path` the canonical section path. Nothing was saved.

```json
{
  "errors": [
    "widget.button.text_color must be a hex color"
  ],
  "code": "invalid_params",
  "details": [
    {
      "code": "invalid_params",
      "message": "must be a hex color",
      "path": "widget.button.text_color",
      "value": "blue",
      "expected": {
        "type": "string"
      }
    }
  ]
}
```

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