Skip to content
STOQDevelopers
Open STOQ

Update email style

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

PATCH
/account/templates/email_style
curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/account/templates/email_style \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "font_family": "string", "header_font_size": "string", "description_font_size": "string", "logo_size": "string" }'

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

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
font_family
header_font_size
description_font_size
logo_size

Example 

{
  "font_family": "string",
  "header_font_size": "string",
  "description_font_size": "string",
  "logo_size": "string"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

202

Section titled “202”

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object
job_id
string
status_url
string

Example 

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

401

Section titled “401”

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Unauthorized"
  ]
}

422

Section titled “422”

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "name is required"
  ]
}

429

Section titled “429”

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

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Rate limit exceeded"
  ]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support