Skip to content

Upload the email logo

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

POST/account/templates/email_style/logo

Costs 2 rate-limit points · Rate limits

Upload the logo every STOQ email shows, back-in-stock and preorder alike, as the template editor's logo drop zone does. Replaces the current logo.

Send the image as multipart/form-data in the file field: a PNG, JPEG, GIF or WebP file of 2 MB or less, checked from the file's bytes, not the type it is sent as. There is no URL upload, as there is none in the dashboard. Returns the email style with the new logo_url; logo_size sets its width.

Also searched asupload email logochange email logoadd logo to emails

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

  • filestring

    The logo image sent as multipart/form-data, a PNG, JPEG, GIF or WebP file of 2 MB or less.

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_urlstring
    Example: https://app.stoqapp.com/rails/active_storage/blobs/redire…

Errors

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.

POST/account/templates/email_style/logo
curl -X POST "https://app.stoqapp.com/api/v2/external/account/templates/email_style/logo" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "string"
  }'
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"
}