> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get email and alert settings > What the store's emails say, which alerts it is sent, the coupon for a first order, and whether an order with no review is given one (`autoReviews`). Its Discord webhook is answered only as saved or not. These settings are changed in the dashboard. Needs the `store.read` permission (Read Store). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/email-settings openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/email-settings: get: tags: - Store summary: Get email and alert settings description: >- What the store's emails say, which alerts it is sent, the coupon for a first order, and whether an order with no review is given one (`autoReviews`). Its Discord webhook is answered only as saved or not. These settings are changed in the dashboard. Needs the `store.read` permission (Read Store). operationId: store.emailSettings parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: fromName: type: string replyTo: type: string defaultInstructions: type: string buttons: type: - array - object buttonDefaultLabel: type: string maxButtons: type: integer panelButtonUrl: type: string autoReviews: type: boolean firstOrderCouponEnabled: type: boolean firstOrderCouponPercent: type: integer firstOrderCouponDays: type: integer firstOrderCouponDelivery: type: string firstOrderCouponDelayMinutes: type: integer firstOrderCouponPrefix: type: string maxFirstOrderPercent: type: integer maxFirstOrderDays: type: integer notifyEnabled: type: boolean notifyAddress: type: string emailStockEnabled: type: boolean emailStockThreshold: type: integer emailPayoutsEnabled: type: boolean emailCustomPaidEnabled: type: boolean emailTicketsEnabled: type: boolean emailDisputeOpenedEnabled: type: boolean emailDisputeClosedEnabled: type: boolean testEmailEvery: type: object properties: limit: type: integer window: type: integer discordWebhookSet: type: boolean discordWebhookMasked: type: string discordOrdersEnabled: type: boolean discordStockEnabled: type: boolean discordErrorsEnabled: type: boolean discordReviewsEnabled: type: boolean discordPayoutsEnabled: type: boolean discordCustomPaidEnabled: type: boolean discordTicketsEnabled: type: boolean discordDisputesEnabled: type: boolean discordStockThreshold: type: integer discordFailure: nullable: true storeName: type: string emailAccent: type: string updatedAt: type: string version: type: string example: success: true message: null code: null data: fromName: '' replyTo: '' defaultInstructions: '' buttons: [] buttonDefaultLabel: Set Up and Download maxButtons: 4 panelButtonUrl: https://northwind.myshoply.gg/customer-panel autoReviews: true firstOrderCouponEnabled: false firstOrderCouponPercent: 10 firstOrderCouponDays: 30 firstOrderCouponDelivery: separate firstOrderCouponDelayMinutes: 15 firstOrderCouponPrefix: ENJOY_ maxFirstOrderPercent: 90 maxFirstOrderDays: 3650 notifyEnabled: false notifyAddress: '' emailStockEnabled: false emailStockThreshold: 5 emailPayoutsEnabled: true emailCustomPaidEnabled: true emailTicketsEnabled: true emailDisputeOpenedEnabled: true emailDisputeClosedEnabled: true testEmailEvery: limit: 1 window: 300 discordWebhookSet: false discordWebhookMasked: '' discordOrdersEnabled: false discordStockEnabled: false discordErrorsEnabled: false discordReviewsEnabled: false discordPayoutsEnabled: false discordCustomPaidEnabled: false discordTicketsEnabled: false discordDisputesEnabled: false discordStockThreshold: 5 discordFailure: null storeName: Northwind Keys emailAccent: '#6a3ce2' updatedAt: '2026-10-22T16:20:18.564Z' version: 5b2d9f49b442e1162e455b53 '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.store.emailSettings(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->store->emailSettings(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.store.emailSettings() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.