Skip to content
STOQDevelopers
Open STOQ

Update sending

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

PATCH
/account/sending
curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/account/sending \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "email_provider": "string", "sms_provider": "string", "email_from_name": "Summer Sneaker Drop", "use_custom_email_address": "string", "email_reply_to_address": "string", "sms_custom_domain_enabled": true, "klaviyo_skip_auto_subscribe": "string", "postscript_api_key": "string", "email_style": "string" }'

Update who sends the shop’s customer notifications: email and SMS provider, sender name, the merchant’s own sending address, store domain in SMS links, Klaviyo marketing consent and the Postscript API key (write only). Also the email look every template shares: font, header and description text sizes, and logo size.

Note: Applies to back-in-stock and preorder notifications. use_custom_email_address true needs email_reply_to_address on a domain that is not a free mail provider, and DKIM set up for it before mail goes out from it. postscript_api_key is never returned by any read; it is checked with Postscript and not saved when Postscript refuses it; “” removes it.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email_provider
sms_provider
email_from_name
use_custom_email_address
email_reply_to_address
sms_custom_domain_enabled
klaviyo_skip_auto_subscribe
postscript_api_key
email_style

Example 

{
  "email_provider": "string",
  "sms_provider": "string",
  "email_from_name": "Summer Sneaker Drop",
  "use_custom_email_address": "string",
  "email_reply_to_address": "string",
  "sms_custom_domain_enabled": true,
  "klaviyo_skip_auto_subscribe": "string",
  "postscript_api_key": "string",
  "email_style": "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