Skip to content

Update the 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

    Font of every STOQ email, back-in-stock and preorder alike. One of the editor's font stacks.

    One of sans-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-serif
  • header_font_sizeinteger

    Header text size of every STOQ email, in pixels.

  • description_font_sizeinteger

    Description text size of every STOQ email, in pixels.

  • logo_sizeinteger

    Logo width of every STOQ email, in pixels. Shows only when a logo is uploaded.

Returns

  • font_familystring
    Example: Helvetica Neue, Helvetica, Arial, sans-serif
  • header_font_sizeinteger
    Example: 28
  • description_font_sizeinteger
    Example: 16
  • logo_sizeinteger
    Example: 160
  • logo_urlnull
    Example: https://app.stoqapp.com/rails/active_storage/blobs/redire…

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
idempotency_key_in_progress

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

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The 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.

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": "Helvetica Neue, Helvetica, Arial, sans-serif",
    "header_font_size": 28,
    "logo_size": 160
  }'
Response
{
  "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"
}