---
title: "Get Email Config"
method: GET
path: "/vendor/customer-email-config"
tags: ["Customer Email Config"]
---

# Get Email Config

`GET /vendor/customer-email-config`

## Response `200`

Successful response

- ICustomerEmailConfigDb
  - `id` string, required
  - `createdDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
  - `updatedDate` string, required — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
  - `deletedAt` string — A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ
  - `sendSubscriptionCreateSignupEmail` boolean
  - `sendSubscriptionCreateSignupEmailBcc` boolean
  - `subscriptionCreateSignupEmailSubject` string
  - `subscriptionCreateSignupEmailBody` string
  - `subscriptionCreateSignupEmailBccAddress` string, nullable
  - `sendSubscriptionCreateEmail` boolean
  - `sendSubscriptionCreateEmailBcc` boolean
  - `subscriptionCreateEmailSubject` string
  - `subscriptionCreateEmailBody` string
  - `subscriptionCreateEmailBccAddress` string, nullable
  - `sendCancelEmail` boolean
  - `sendCancelEmailBcc` boolean
  - `cancelEmailSubject` string
  - `cancelEmailBody` string
  - `cancelEmailBccAddress` string, nullable
  - `sendUpcomingOrderEmail` boolean
  - `sendUpcomingOrderEmailBcc` boolean
  - `upcomingOrderEmailSubject` string
  - `upcomingOrderEmailBody` string
  - `upcomingOrderEmailBccAddress` string, nullable
  - `upcomingOrderEmailDeliveryDelay` number
  - `sendExpiredPaymentMethodEmail` boolean
  - `sendExpiredPaymentMethodEmailBcc` boolean
  - `expiredPaymentMethodEmailSubject` string
  - `expiredPaymentMethodEmailBody` string
  - `expiredPaymentMethodEmailBccAddress` string, nullable
  - `sendUpdatePaymentEmailOnFailedPayment` boolean
  - `sendUpcomingGiftEmail` boolean
  - `sendUpcomingGiftEmailBcc` boolean
  - `upcomingGiftEmailSubject` string
  - `upcomingGiftEmailBody` string
  - `upcomingGiftEmailBccAddress` string, nullable
  - `sendGiftIsBeingSentEmail` boolean
  - `sendGiftIsBeingSentEmailBcc` boolean
  - `giftIsBeingSentEmailSubject` string
  - `giftIsBeingSentEmailBody` string
  - `giftIsBeingSentEmailBccAddress` string, nullable
  - `sendGifterUpcomingGiftEmail` boolean
  - `gifterUpcomingGiftEmailSubject` string
  - `gifterUpcomingGiftEmailBody` string
  - `sendGifterUpcomingGiftEmailBcc` boolean
  - `gifterUpcomingGiftEmailBccAddress` string, nullable
  - `itemOutOfStockEmail` boolean
  - `itemOutOfStockEmailBcc` boolean
  - `itemOutOfStockEmailSubject` string
  - `itemOutOfStockEmailBody` string
  - `itemOutOfStockEmailBccAddress` string, nullable
  - `sendSubscriptionPausedEmail` boolean
  - `sendSubscriptionPausedEmailBcc` boolean
  - `subscriptionPausedEmailSubject` string
  - `subscriptionPausedEmailBody` string
  - `subscriptionPausedEmailBccAddress` string, nullable
  - `sendSubscriptionAutoResumeEmail` boolean
  - `sendSubscriptionAutoResumeEmailBcc` boolean
  - `subscriptionAutoResumeEmailSubject` string
  - `subscriptionAutoResumeEmailBody` string
  - `subscriptionAutoResumeEmailBccAddress` string, nullable
  - `sendSubscriptionResumedEmail` boolean
  - `sendSubscriptionResumedEmailBcc` boolean
  - `subscriptionResumedSubject` string
  - `subscriptionResumedEmailBody` string
  - `subscriptionResumedEmailBccAddress` string, nullable
  - `emailHeader` string
  - `emailFooter` string
  - `emailTheming` object
    - `logo` string
    - `logoWidth` number
    - `useHeaderAndFooter` boolean
    - `useStyling` boolean
    - `colors` object
      - `backgroundColor` string
      - `primaryTextColor` string
      - `secondaryTextColor` string
      - `buttonBackgroundColor` string
      - `buttonTextColor` string
  - `isArpuEnabled` boolean
  - `oneTimeCodeEmailSubject` string
  - `oneTimeCodeEmailBody` string
  - `magicLinkEmailSubject` string
  - `magicLinkEmailBody` string
  - `sendSuccessfulReferralEmail` boolean
  - `sendSuccessfulReferralEmailBcc` boolean
  - `successfulReferralEmailSubject` string
  - `successfulReferralEmailBody` string
  - `successfulReferralEmailBccAddress` string, nullable
  - `sendPaymentFailureEmail` boolean
  - `sendPaymentFailureEmailBcc` boolean
  - `paymentFailureEmailSubject` string
  - `paymentFailureEmailBody` string
  - `paymentFailureEmailBccAddress` string, nullable
  - `sendAccountCreationReminderEmail` boolean
  - `sendAccountCreationReminderEmailBcc` boolean
  - `accountCreationReminderEmailSubject` string
  - `accountCreationReminderEmailBody` string
  - `accountCreationReminderEmailBccAddress` string, nullable
  - `sendBonusEarnedEmail` boolean
  - `sendBonusEarnedEmailBcc` boolean
  - `bonusEarnedEmailSubject` string
  - `bonusEarnedEmailBody` string
  - `bonusEarnedEmailBccAddress` string, nullable
  - `sendOtpCodeRedeemedEmail` boolean
  - `sendOtpCodeRedeemedEmailBcc` boolean
  - `otpCodeRedeemedEmailSubject` string
  - `otpCodeRedeemedEmailBody` string
  - `otpCodeRedeemedEmailBccAddress` string, nullable
  - `sendRewardReminderEmail` boolean
  - `sendRewardReminderEmailBcc` boolean
  - `rewardReminderEmailSubject` string
  - `rewardReminderEmailBody` string
  - `rewardReminderEmailBccAddress` string, nullable
  - `sendRewardOutOfStockEmail` boolean
  - `sendRewardOutOfStockEmailBcc` boolean
  - `rewardOutOfStockEmailSubject` string
  - `rewardOutOfStockEmailBody` string
  - `rewardOutOfStockEmailBccAddress` string, nullable
  - `sendLoyaltyCurrencyReminder` boolean
  - `loyaltyCurrencyReminderEmailBody` string
  - `loyaltyCurrencyReminderEmailSubject` string
  - `sendMigrationSummaryEmail` boolean
  - `migrationSummaryEmailBody` string
  - `migrationSummaryEmailSubject` string
  - `sendInsightsEmail` boolean
  - `sendLoyaltyWelcomeEmail` boolean
  - `sendLoyaltyWelcomeEmailBcc` boolean
  - `loyaltyWelcomeEmailSubject` string
  - `loyaltyWelcomeEmailBody` string
  - `loyaltyWelcomeEmailBccAddress` string, nullable
  - `sendLoyaltyTiersWelcomeEmail` boolean
  - `sendLoyaltyTiersWelcomeEmailBcc` boolean
  - `loyaltyTiersWelcomeEmailSubject` string
  - `loyaltyTiersWelcomeEmailBody` string
  - `loyaltyTiersWelcomeBccAddress` string, nullable
  - `sendLoyaltyTierAdvancementEmail` boolean
  - `sendLoyaltyTierAdvancementEmailBcc` boolean
  - `loyaltyTierAdvancementEmailSubject` string
  - `loyaltyTierAdvancementEmailBody` string
  - `loyaltyTierAdvancementBccAddress` string, nullable

---

[API](https://skmtc.net/smartrr/apis/smartrr-api.md) · [All operations](https://skmtc.net/smartrr/apis/smartrr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartrr/smartrr-api/revisions/da24e062ff11/schema)