Retrieve the sending

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

GET/account/sending

Costs 1 rate-limit point · Rate limits

Who sends each customer notification, and STOQ's own sending settings. notifications nests each channel under its notification: back_in_stock (signup_thank_you, restock_alert, reminder) and preorders (confirmation, shipping_update, payment_failed), each channel with sender (who sends it right now, worked out by the same code the sender runs; null means it is not sent) and fallback_reason (why the sender is not the chosen email_provider or sms_provider: credentials_missing, flow_unverified, flow_trigger_disabled, flow_not_supported, custom_html_template). stoq is STOQ's own email and SMS. Also returns the sender name and address, reply-to, the custom sending domain and its DKIM check, and whether STOQ lets the shop send: email_allowed (false when STOQ has blocked the shop's email), sms_allowed (SMS approved) and sms_restricted_content_verified (staff reviewed the SMS content). STOQ sets these three; they cannot be written. sending_paused, present only when STOQ blocks a channel, says alerts on it will not go out. custom_address_status says where sending from the merchant's own address stands: not_set (use_custom_email_address is off or no address of their own), pending (DKIM for the address's domain is not verified yet, so mail goes from STOQ's address) or verified (mail goes from the merchant's address). The DNS records to add while pending come from POST /account/sending/verify_domain, which asks Amazon SES.

Also searched asemail providersms providersender addressfrom addresscustom sending domainsending settingswho sends my notificationsis klaviyo sending my alertswhy did stoq send instead of klaviyois my sender address verifiedwhy are emails not sent from my address

Errors

401

Missing or invalid X-Auth-Token.

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.

GET/account/sending

curl "https://app.stoqapp.com/api/v2/external/account/sending" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/sending", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/account/sending",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/sending")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "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
    }
  ]
}