Skip to content
STOQDevelopers
Open STOQ

Update confirmation

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

PATCH
/preorders/templates/confirmation
curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "email": { "subject": "string", "preheader": "string", "heading": "string", "body": "string", "footer": "string", "button": { "text": "Preorder now", "background_color": "#1A1A1A", "text_color": "#1A1A1A", "radius": 0 }, "colors": { "background": "string", "section": "string", "text": "Preorder now" }, "radius": 0, "css": "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" }, "klaviyo_flow_name": "Summer Sneaker Drop" }, "sms": { "body": "string", "klaviyo_flow_name": "Summer Sneaker Drop" }, "locale": "fr" }'

Update the preorder confirmation notification’s email and SMS copy. The body is the GET shape: email{subject, preheader, heading, body, footer, button{text, background_color, text_color, radius}, colors{background, section, text}, radius, css, reviews{enabled, count, min_rating, title}, social{…}, klaviyo_flow_name} and sms{body, klaviyo_flow_name}. An optional body locale writes the copy in that language only; omit it for the shop default. Turning the email or SMS on or off is PATCH /preorders/notification_settings/confirmation.

Note: Deep partial: absent fields are unchanged, unknown or read-only keys are rejected; errors are 422 keyed “template.”. Rejects HTML (except in email.css) and runs Template validations and callbacks, so sms.body must keep its required Liquid variables. Social links and the icon colour are shared: saving one sets it on every notification template of the shop. Returns the template.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
object
subject

Subject of the preorder confirmation email.

string
preheader

Pre-header – the preview line after the subject in the inbox.

string
heading

Heading at the top of the email body.

string
body

Description – the main body copy of the email.

string
footer

Cancel order link – the text of the link that lets customers cancel their preorder. Only shown while “Allow customers to cancel preorders” is on.

string
button
object
text

Button text on the email call to action.

string
background_color

Button – Background colour of the email button. Hex.

string
/^#([0-9a-fA-F]{3,8})$/
text_color

Button – Text colour of the email button. Hex.

string
/^#([0-9a-fA-F]{3,8})$/
radius

Corner radius of the email button, in pixels.

integer
colors
object
background

Colors – Background of the email, around the content. Hex, e.g. “#F9F9F9”.

string
/^#([0-9a-fA-F]{3,8})$/
section

Colors – Background of the content section of the email. Hex.

string
/^#([0-9a-fA-F]{3,8})$/
text

Colors – Text colour of the email. Hex.

string
/^#([0-9a-fA-F]{3,8})$/
radius

Corner radius of the content section, in pixels.

integer
css

Custom CSS added to the email. Applies to the standard email design. An empty string removes it.

string
reviews
object
enabled

Show product reviews: adds the product’s Judge.me star rating and top reviews to the preorder confirmation and shipping update emails. Paid plans only; shows only while Judge.me is connected (Settings > Integrations).

boolean
count

Number of reviews to show in the Judge.me reviews block, 1 to 3.

integer
>= 1 <= 3
min_rating

Only show reviews rated at least this many stars: 5, 4 or 3.

integer
Allowed values: 5 4 3
title

Section title for the Judge.me reviews block on the email, e.g. “What customers are saying”.

string
social
object
facebook

Facebook profile URL, without the https:// prefix. Shows as an icon in the email. Saving a social link sets it on every notification template of the shop. An empty string removes it.

string
instagram

Instagram profile URL, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
pinterest

Pinterest profile URL, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
twitter

X (Twitter) profile URL, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
tiktok

TikTok profile URL, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
whatsapp

WhatsApp link, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
youtube

YouTube channel URL, without the https:// prefix. Saving a social link sets it on every notification template of the shop.

string
icon_color

Icon Color of the social icons: white (#FFFFFF) or black (#000000). Shared by every template.

string
Allowed values: #FFFFFF #000000
klaviyo_flow_name

Flow name to trigger in Klaviyo instead of sending the email here. Only used while the email platform is Klaviyo.

string
sms
object
body

SMS Body – the text message sent instead of the email. Must keep its Liquid variables.

string
klaviyo_flow_name

Flow name to trigger in Klaviyo instead of sending the SMS here. Only used while the SMS platform is Klaviyo.

string
locale

Language the translated fields are written in, such as ‘fr’ or ‘pt-BR’. Omitted: the shop’s default language. Untranslated fields ignore it.

string

Example 

{
  "email": {
    "subject": "string",
    "preheader": "string",
    "heading": "string",
    "body": "string",
    "footer": "string",
    "button": {
      "text": "Preorder now",
      "background_color": "#1A1A1A",
      "text_color": "#1A1A1A",
      "radius": 0
    },
    "colors": {
      "background": "string",
      "section": "string",
      "text": "Preorder now"
    },
    "radius": 0,
    "css": "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"
    },
    "klaviyo_flow_name": "Summer Sneaker Drop"
  },
  "sms": {
    "body": "string",
    "klaviyo_flow_name": "Summer Sneaker Drop"
  },
  "locale": "fr"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

202

Section titled “202”

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

Media typeapplication/json
object

Example generated

{}

401

Section titled “401”

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Unauthorized"
  ]
}

422

Section titled “422”

Invalid fields, keyed by canonical section paths. Nothing was saved.

Media typeapplication/json
object
errors
required
object
key
additional properties
Array<string>

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

429

Section titled “429”

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Rate limit exceeded"
  ]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support