Skip to content

NewsletterSubscription ​

Type: schema

Description ​

A newsletter subscription: an email subscribed to the store's newsletter.

TypeScript Definition ​

typescript
NewsletterSubscription: {{
            id: number;
            email: string;
            store_id: string;
            /** @description As given when subscribing (default `false`); Commerce Engine doesn't verify it. */
            is_email_verified: boolean;
            created_at: string;
            modified_at: string;
        };
        /**
         * NotificationChannelPreferences
         * @description Set specific channel preferences
         */
}

OpenAPI Schema ​

json
{
  "title": "NewsletterSubscription",
  "description": "A newsletter subscription: an email subscribed to the store's newsletter.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/NewsletterSubscription",
    "description": "API reference for the NewsletterSubscription schema"
  },
  "required": [
    "created_at",
    "email",
    "id",
    "is_email_verified",
    "modified_at",
    "store_id"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "email": {
      "type": "string"
    },
    "store_id": {
      "type": "string"
    },
    "is_email_verified": {
      "description": "As given when subscribing (default `false`); Commerce Engine doesn't verify it.",
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "modified_at": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: