Update the sending

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

PATCH/account/sending

Costs 2 rate-limit points · Rate limits

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). The email font, text sizes and logo size are PATCH /account/templates/email_style.

Deep partial: absent fields are unchanged. 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 (POST /account/sending/verify_domain) before mail goes out from it. postscript_api_key is never returned by any read; it is checked with Postscript before anything is saved, and nothing is saved when Postscript refuses it; "" removes it.

Also searched asswitch email providersend emails with klaviyosend emails from stoqswitch sms provideruse postscriptset postscript api keychange sender namesend from my own email addressuse store domain in sms linkschange preorder notification provider

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

email_providerstring
Example: string
sms_providerstring
Example: string
email_from_namestring
Example: Summer Sneaker Drop
use_custom_email_addressstring
Example: string
email_reply_to_addressstring
Example: string
sms_custom_domain_enabledboolean
Example: true
klaviyo_skip_auto_subscribestring
Example: string
postscript_api_keystring
Example: string

Errors

401

Missing or invalid X-Auth-Token.

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

PATCH/account/sending

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

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/sending", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "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"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.stoqapp.com/api/v2/external/account/sending",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "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"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/sending")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  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"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

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

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}