---
title: "Update a template"
description: "Update one back-in-stock notification's email and SMS copy. key is \"signup_thank_you\", \"restock_alert\" or \"reminder\". The body is the GET shape: email{subject, preheader, heading, body, footer, button{...}, colors{...}, "
url: https://docs.stoqapp.com/v2-reference/back-in-stock-templates/update-a-template/
api: "API v2 reference"
method: PATCH
path: "/back_in_stock/templates/{key}"
---

# Update a template

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

Update one back-in-stock notification's email and SMS copy. key is "signup_thank_you", "restock_alert" or "reminder". The body is the GET shape: email{subject, preheader, heading, body, footer, button{...}, colors{...}, radius, css, html{enabled, template}, reviews{...}, social{...}, unsubscribe_text, klaviyo_flow_name} and sms{body, link_destination, klaviyo_flow_name}. An optional body `locale` ("fr", "pt-BR") writes the copy in that language only; omit it for the shop default. Colours, switches and other untranslated fields ignore it. Turning a notification on or off, and its timing, is [`PATCH /back_in_stock/notification_settings/:key`](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/update-a-notification-setting/).

**Note:** Deep partial: absent fields are unchanged; unknown or read-only keys are rejected (signup_thank_you has no email.button.destination or sms.link_destination). Errors are 422 keyed "template.<path>"; nothing is saved when any field fails. Rejects HTML except in email.html.template and email.css, and runs Template validations and callbacks. Colours, corner radii and the Judge.me reviews block are shared by the restock alert and the reminder; social links, the icon colour and email.unsubscribe_text by every template of 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

- `email` (object)
  - `subject` (string): Subject of the email. Takes the editor variables, e.g. {{product.title_incl_variant}} or {{shop.name}} (get_bis_template lists them all); a bare {{product}} is not a variable.
  - `preheader` (string): Pre-header -- the preview line after the subject in the inbox. Takes the editor variables, e.g. {{product.title_incl_variant}} or {{shop.name}} (get_bis_template lists them all); a bare {{product}} is not a variable.
  - `heading` (string): Heading at the top of the email body. Takes the editor variables, e.g. {{product.title_incl_variant}} or {{shop.name}} (get_bis_template lists them all); a bare {{product}} is not a variable.
  - `body` (string): Description -- the main body copy of the email. Takes the editor variables, e.g. {{product.title_incl_variant}} or {{shop.name}} (get_bis_template lists them all); a bare {{product}} is not a variable.
  - `footer` (string): Footer line at the bottom of the email.
  - `button` (object)
    - `text` (string): Button text on the email.
    - `destination` (string): "Take customer to": where the email button lands, the checkout or the product page. Not on signup_thank_you. One of: `checkout`, `product`.
    - `background_color` (string): Button -- Background colour of the email button. Hex.
    - `text_color` (string): Button -- Text colour of the email button. Hex.
    - `radius` (integer): Corner radius of the email button, in pixels. Saving it sets it on the restock alert and the reminder alike.
  - `colors` (object)
    - `background` (string): Colors -- Background of the email. Hex, e.g. "#FFFFFF".
    - `section` (string): Colors -- Background of the content section of the email. Hex. Saving it sets it on the restock alert and the reminder alike.
    - `text` (string): Colors -- Text colour of the email. Hex.
  - `radius` (integer): Corner radius of the content section, in pixels. Saving it sets it on the restock alert and the reminder alike.
  - `css` (string): Custom CSS added to the email. Applies to the standard email design. An empty string removes it.
  - `html` (object)
    - `enabled` (boolean): The "Use HTML template" switch: true sends email.html.template, false the standard STOQ email.
    - `template` (string): The custom HTML email (Custom HTML tab). Sent instead of the standard email while email.html.enabled is true. Takes the same {{ }} variables as the editor. Paid plans only.
  - `reviews` (object)
    - `enabled` (boolean): Show product reviews: adds the product's Judge.me star rating and top reviews to the email. Paid plans only; shows only while Judge.me is connected (Settings > Integrations). Saving it sets it on the restock alert and the reminder alike.
    - `count` (integer): Number of reviews to show in the Judge.me reviews block, 1 to 3. Saving it sets it on the restock alert and the reminder alike.
    - `min_rating` (integer): Only show reviews rated at least this many stars: 5, 4 or 3. Saving it sets it on the restock alert and the reminder alike. One of: `5`, `4`, `3`.
    - `title` (string): Section title of the Judge.me reviews block, e.g. "What customers are saying". Saving it sets it on the restock alert and the reminder alike.
  - `social` (object)
    - `facebook` (string): Facebook profile URL, without the https:// prefix. Shows as an icon in the email. Saving it sets it on every notification template of the shop.
    - `instagram` (string): Instagram profile URL, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `pinterest` (string): Pinterest profile URL, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `twitter` (string): X (Twitter) profile URL, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `tiktok` (string): TikTok profile URL, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `whatsapp` (string): WhatsApp link, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `youtube` (string): YouTube channel URL, without the https:// prefix. Saving it sets it on every notification template of the shop.
    - `icon_color` (string): Icon Color of the social icons: white (#FFFFFF) or black (#000000). Saving it sets it on every notification template of the shop. One of: `#FFFFFF`, `#000000`.
  - `unsubscribe_text` (string): Text of the unsubscribe link at the bottom of the email. Saving it sets it on every notification template of the shop.
  - `klaviyo_flow_name` (string): Flow name to trigger in Klaviyo instead of sending the email here. Only used while the email platform is Klaviyo.
- `sms` (object)
  - `body` (string): SMS Body -- the text message sent instead of the email. Takes the editor variables, e.g. {{product.title_incl_variant}} or {{shop.name}} (get_bis_template lists them all); a bare {{product}} is not a variable.
  - `link_destination` (string): "Link takes customer to": where the SMS link lands, the checkout or the product page. Not on signup_thank_you. One of: `checkout`, `product`.
  - `klaviyo_flow_name` (string): Flow name to trigger in Klaviyo instead of sending the SMS here. Only used while the SMS 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/back_in_stock/templates/{key}" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": {
      "subject": "string",
      "preheader": "string",
      "heading": "string",
      "body": "string",
      "footer": "string",
      "button": {
        "text": "Preorder now",
        "destination": "checkout",
        "background_color": "#1A1A1A",
        "text_color": "#1A1A1A",
        "radius": 0
      },
      "colors": {
        "background": "string",
        "section": "string",
        "text": "Preorder now"
      },
      "radius": 0,
      "css": "string",
      "html": {
        "enabled": true,
        "template": "string"
      },
      "reviews": {
        "enabled": true,
        "count": 5,
        "min_rating": 5,
        "title": "string"
      },
      "social": {
        "facebook": "string",
        "instagram": "string",
        "pinterest": "string",
        "twitter": "string",
        "tiktok": "string",
        "whatsapp": "string",
        "youtube": "string",
        "icon_color": "#FFFFFF"
      },
      "unsubscribe_text": "Preorder now",
      "klaviyo_flow_name": "Summer Sneaker Drop"
    },
    "sms": {
      "body": "string",
      "link_destination": "checkout",
      "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
    }
  ]
}
```

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

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