Update the email style
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/templates/email_styleCosts 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-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
font_familystringFont of every STOQ email, back-in-stock and preorder alike. One of the editor's font stacks.
One ofsans-serifBaskerville, Century Gothic, sans-serif;Courier New, Courier, monospaceFutura, sans-serifGaramond, Baskerville, Caslon, sans-serifGeorgia, sans-serifGill Sans, Gill Sans Nova, Gill Sans MT, Calibri, Trebuchet MS, sans‑serifHelvetica Neue, Helvetica, Arial, sans-serifImpact, sans-serifLucida Grande, sans-serifMonaco, monospacePalatino, serifRockwell, sans-serif'Segoe UI', 'Segoe UI', sans-serifTahoma, Verdana, Segoe, sans-serif'Times New Roman', Times, serif'Trebuchet MS', sans-serifVerdana, Geneva, sans-serifheader_font_sizeintegerHeader text size of every STOQ email, in pixels.
description_font_sizeintegerDescription text size of every STOQ email, in pixels.
logo_sizeintegerLogo width of every STOQ email, in pixels. Shows only when a logo is uploaded.
Returns
font_familystringExample:Helvetica Neue, Helvetica, Arial, sans-serifheader_font_sizeintegerExample:28description_font_sizeintegerExample:16logo_sizeintegerExample:160logo_urlnullExample:https://app.stoqapp.com/rails/active_storage/blobs/redire…
Errors
not_foundThe path is valid but nothing with that id exists in this store.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
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": "Helvetica Neue, Helvetica, Arial, sans-serif",
"header_font_size": 28,
"logo_size": 160
}'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": "Helvetica Neue, Helvetica, Arial, sans-serif",
"header_font_size": 28,
"logo_size": 160
}),
});
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": "Helvetica Neue, Helvetica, Arial, sans-serif",
"header_font_size": 28,
"logo_size": 160
},
)
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: "Helvetica Neue, Helvetica, Arial, sans-serif",
header_font_size: 28,
logo_size: 160
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"font_family": "Helvetica Neue, Helvetica, Arial, sans-serif",
"header_font_size": 28,
"description_font_size": 16,
"logo_size": 160,
"logo_url": "https://app.stoqapp.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--0000000000000000000000000000000000000000/stride-supply-logo.png"
}{
"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
}
]
}