Update shipping update

PATCH

/preorders/templates/shipping_update

curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/templates/shipping_update \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "email": { "subject": "string", "heading": "string", "body": "string", "klaviyo_flow_name": "Summer Sneaker Drop" }, "locale": "fr" }'

• Production

Update the shipping-update email STOQ sends when a preorder ships late or its date changes: its subject, heading, body 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.”. Returns the template.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

email

object

subject

Email subject of the shipping-update email. Liquid variables such as {{order.name}} work.

string

heading

Heading at the top of the shipping-update email.

string

body

Message body of the shipping-update email.

string

klaviyo_flow_name

Klaviyo flow to trigger for the shipping update instead of sending it here. Only used while the email 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",
    "heading": "string",
    "body": "string",
    "klaviyo_flow_name": "Summer Sneaker Drop"
  },
  "locale": "fr"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

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

Media typeapplication/json

object

Example ^generated

{}

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

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

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