---
title: "Get sending settings"
description: "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, shipp"
url: https://docs.stoqapp.com/v2-reference/account-sending/get-sending-settings/
api: "API v2 reference"
method: GET
path: "/account/sending"
---

# Get sending settings

`GET https://app.stoqapp.com/api/v2/external/account/sending`

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 &quot; (STOQ)&quot; 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`](https://docs.stoqapp.com/v2-reference/account-sending/verify-the-sending-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.

**Note:** 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`](https://docs.stoqapp.com/v2-reference/account-sending/update-sending-settings/).

## Returns

- `email_provider` (string): e.g. `stoq`
- `sms_provider` (string): e.g. `stoq`
- `email_from_name` (string, nullable): e.g. `Stride Supply`
- `use_custom_email_address` (boolean): e.g. `true`
- `sender_address` (string, nullable): e.g. `hello@stridesupply.com`
- `sms_custom_domain_enabled` (boolean): e.g. `true`
- `klaviyo_skip_auto_subscribe` (boolean): e.g. `false`
- `email_from_address` (string, nullable): e.g. `hello@stridesupply.com`
- `email_subdomain` (string, nullable)
- `email_dkim_verified` (boolean): e.g. `true`
- `sms_allowed` (boolean): e.g. `true`
- `email_allowed` (boolean): e.g. `true`
- `reply_to_address` (string): e.g. `hello@stridesupply.com`
- `sms_restricted_content_verified` (boolean): e.g. `true`
- `custom_address_status` (string): e.g. `verified`
- `sent_from` (object)
  - `name` (string): e.g. `Stride Supply`
  - `back_in_stock` (string): e.g. `hello@stridesupply.com`
  - `preorders` (string): e.g. `hello@stridesupply.com`
  - `yahoo_outlook_hotmail_recipients` (string): e.g. `hello@stridesupply.com`
- `notifications` (object)
  - `back_in_stock` (object)
    - `signup_thank_you` (object)
      - `email` (object)
        - `sender` (string)
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean)
      - `sms` (object)
        - `sender` (string, nullable)
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean)
    - `restock_alert` (object)
      - `email` (object)
        - `sender` (string): e.g. `stoq`
        - `fallback_reason` (null)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
      - `sms` (object)
        - `sender` (string, nullable): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
    - `reminder` (object)
      - `email` (object)
        - `sender` (string): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
      - `sms` (object)
        - `sender` (string, nullable): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
  - `preorders` (object)
    - `confirmation` (object)
      - `email` (object)
        - `sender` (string): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
      - `sms` (object)
        - `sender` (string, nullable): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
    - `shipping_update` (object)
      - `email` (object)
        - `sender` (string): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
    - `payment_failed` (object)
      - `email` (object)
        - `sender` (string): e.g. `stoq`
        - `fallback_reason` (string, nullable)
        - `integration` (object, nullable)
        - `enabled` (boolean): e.g. `true`
- `sending_paused` (object)
  - `channels` (array of strings)
  - `note` (string)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

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

## 200

Success: example response shown.

```json
{
  "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
        }
      }
    }
  }
}
```

## 401

Missing or invalid `X-Auth-Token`.

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

## 422

The request failed validation.

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

## 429

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

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

