Update email style

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

PATCH/account/templates/email_style

Costs 2 rate-limit points · Rate limits

Update the look every STOQ email shares, back-in-stock and preorder alike: font, header and description text sizes, and logo size.

Deep partial: absent fields are unchanged. Applies to every notification template at once, as the template editor does. Sizes are whole pixels above 0.

Also searched aschange email fontchange email text sizechange email logo sizeemail style

Headers

Idempotency-Keystring
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

font_familystring
Example: string
header_font_sizestring
Example: string
description_font_sizestring
Example: string
logo_sizestring
Example: string

Errors

401

Missing or invalid X-Auth-Token.

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

PATCH/account/templates/email_style

curl -X PATCH "https://app.stoqapp.com/api/v2/external/account/templates/email_style" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "font_family": "string",
    "header_font_size": "string",
    "description_font_size": "string",
    "logo_size": "string"
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/templates/email_style", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "font_family": "string",
    "header_font_size": "string",
    "description_font_size": "string",
    "logo_size": "string"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.stoqapp.com/api/v2/external/account/templates/email_style",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "font_family": "string",
        "header_font_size": "string",
        "description_font_size": "string",
        "logo_size": "string"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/templates/email_style")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  font_family: "string",
  header_font_size: "string",
  description_font_size: "string",
  logo_size: "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

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

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}