Create email style logo

POST

/account/templates/email_style/logo

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/account/templates/email_style/logo \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "file": "string" }'

• Production

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.

Note: 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.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

file

Example

{
  "file": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

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

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

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

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"
  ]
}