Skip to content

Get sending settings

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. sent_from is the From of STOQ's own emails, as the dashboard shows it: name (email_from_name, with " (STOQ)" added while mail goes from STOQ's addresses), back_in_stock and preorders (the address each sends from) and yahoo_outlook_hotmail_recipients. email_from_address is the merchant's own address once verified (then every email goes from it), else null. Also returns 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). sender_domain is where the sending domain stands, from Amazon SES and a DNS lookup of each record (checked at most every 5 minutes; checked_at says when): status (verified, pending, failed, not_started, not_set, error), ses_dkim_status (SES's own word), records (each CNAME with host, expected, found and status ok, missing, wrong_value or lookup_failed), next_step (add_records, fix_records, wait_for_ses, restart_verification, none) and in_use (verified and the plan allows a custom sender). POST /account/sending/verify_domain checks again now. sender_address is the merchant's own address to send from, null on STOQ's default address. reply_to_address is where customer replies go: the Reply-To on every customer email STOQ sends. It is sender_address when set, otherwise the store's customer email in Shopify. Replies never go to STOQ.

A notification is listed under notifications only when the shop has its alert template, so preorders is {} on a shop with no preorder template. Each channel also carries enabled (the template is on) and integration (the provider it was meant to go through). sending_paused has channels (email, sms) and a note to relay. Change providers and addresses with PATCH /account/sending.

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 addressreply-to addresswhere do customer replies godkim recordsis my sending domain verifiedwhich dns record is missing

Returns

  • email_providerstring
    Example: stoq
  • sms_providerstring
    Example: stoq
  • email_from_namestring, nullable
    Example: Stride Supply
  • use_custom_email_addressboolean
    Example: true
  • sender_addressstring, nullable
    Example: hello@stridesupply.com
  • sms_custom_domain_enabledboolean
    Example: true
  • klaviyo_skip_auto_subscribeboolean
    Example: false
  • email_from_addressstring, nullable
    Example: hello@stridesupply.com
  • email_subdomainstring, nullable
  • email_dkim_verifiedboolean
    Example: true
  • sms_allowedboolean
    Example: true
  • email_allowedboolean
    Example: true
  • reply_to_addressstring
    Example: hello@stridesupply.com
  • sms_restricted_content_verifiedboolean
    Example: true
  • custom_address_statusstring
    Example: verified
  • sent_fromobject
    Show 4 child attributesHide child attributes
    • namestring
      Example: Stride Supply
    • back_in_stockstring
      Example: hello@stridesupply.com
    • preordersstring
      Example: hello@stridesupply.com
    • yahoo_outlook_hotmail_recipientsstring
      Example: hello@stridesupply.com
  • notificationsobject
    Show 2 child attributesHide child attributes
    • back_in_stockobject
      Show 3 child attributesHide child attributes
      • signup_thank_youobject
        Show 2 child attributesHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
        • smsobject
          Show 4 child attributesHide child attributes
          • senderstring, nullable
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
      • restock_alertobject
        Show 2 child attributesHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
            Example: stoq
          • fallback_reasonnull
          • integrationobject, nullable
          • enabledboolean
            Example: true
        • smsobject
          Show 4 child attributesHide child attributes
          • senderstring, nullable
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
      • reminderobject
        Show 2 child attributesHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
        • smsobject
          Show 4 child attributesHide child attributes
          • senderstring, nullable
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
    • preordersobject
      Show 3 child attributesHide child attributes
      • confirmationobject
        Show 2 child attributesHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
        • smsobject
          Show 4 child attributesHide child attributes
          • senderstring, nullable
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
      • shipping_updateobject
        Show 1 child attributeHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
      • payment_failedobject
        Show 1 child attributeHide child attributes
        • emailobject
          Show 4 child attributesHide child attributes
          • senderstring
            Example: stoq
          • fallback_reasonstring, nullable
          • integrationobject, nullable
          • enabledboolean
            Example: true
  • sending_pausedobject
    Show 2 child attributesHide child attributes
    • channelsarray of strings
    • notestring

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

429
shopify_rate_limited

Shopify throttled the store's Admin API, so the call was not made.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/account/sending
curl "https://app.stoqapp.com/api/v2/external/account/sending" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "email_provider": "stoq",
  "sms_provider": "stoq",
  "email_from_name": "Stride Supply",
  "use_custom_email_address": true,
  "sender_address": "hello@stridesupply.com",
  "sms_custom_domain_enabled": true,
  "klaviyo_skip_auto_subscribe": false,
  "email_from_address": "hello@stridesupply.com",
  "email_subdomain": null,
  "email_dkim_verified": true,
  "sms_allowed": true,
  "email_allowed": true,
  "reply_to_address": "hello@stridesupply.com",
  "sms_restricted_content_verified": true,
  "custom_address_status": "verified",
  "sent_from": {
    "name": "Stride Supply",
    "back_in_stock": "hello@stridesupply.com",
    "preorders": "hello@stridesupply.com",
    "yahoo_outlook_hotmail_recipients": "hello@stridesupply.com"
  },
  "notifications": {
    "back_in_stock": {
      "restock_alert": {
        "email": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        },
        "sms": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        }
      },
      "reminder": {
        "email": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        },
        "sms": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        }
      }
    },
    "preorders": {
      "confirmation": {
        "email": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        },
        "sms": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        }
      },
      "shipping_update": {
        "email": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        }
      },
      "payment_failed": {
        "email": {
          "sender": "stoq",
          "fallback_reason": null,
          "integration": null,
          "enabled": true
        }
      }
    }
  }
}