Skip to content

Get the email style

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

GET/account/templates/email_style

Costs 1 rate-limit point · Rate limits

The look every STOQ email shares, back-in-stock and preorder alike: font, header and description text sizes, logo size, and logo_url (the uploaded logo, null when there is none). The template editor sets these for every template at once.

One set of values for the whole shop: there is no per-template or per-language style. Sizes are in pixels. Change the font and sizes with PATCH /account/templates/email_style; upload or remove the logo with POST or DELETE /account/templates/email_style/logo. logo_size is kept while there is no logo and applies again once one is uploaded.

Also searched asemail styleemail fontemail text sizeemail logo sizeemail logo

Returns

  • font_familystring
    Example: string
  • header_font_sizeinteger
    Example: 1
  • description_font_sizeinteger
    Example: 1
  • logo_sizeinteger
    Example: 1
  • logo_urlstring, nullable
    Example: string

Errors

404
not_found

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

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.

GET/account/templates/email_style
curl "https://app.stoqapp.com/api/v2/external/account/templates/email_style" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "font_family": "string",
  "header_font_size": 1,
  "description_font_size": 1,
  "logo_size": 1,
  "logo_url": "string"
}