docs
  1. Events
  2. Customer Events
  3. Newsletter-subscribed

newsletter-subscribed

A newsletter-subscribed event is triggered when a customer subscribes to a newsletter.

Example:

Properties:

  • key string
  • locale object
    • appId integer
    • countryCode string (minimum length: ) (maximum length: 3)
    • currencyCode string (optional) (minimum length: ) (maximum length: 3)
    • languageCode string (minimum length: ) (maximum length: 5)
  • occurredAt string
  • payload object
    • channel enum (sms email post)
    • clientIps string (optional)
    • customer object
      • id integer
      • anonymisation object (optional)
      • authentication object (optional)
      • birthDate string (optional)
      • customData object (optional) (object is extensible as desired)
      • email string (optional) (maximum length: 60)
      • firstName string
      • gender enum (m f d n) (optional)
      • groups array (optional)
      • identities array (optional)
      • ipAddress string (optional)
      • lastName string
      • phone string (optional)
      • publicKey string (optional) (minimum length: ) (maximum length: 100)
      • referenceKey string (optional) (minimum length: ) (maximum length: 100)
      • status object
      • title null,string (optional) (maximum length: 30)
      • type enum (personal retail organization family)
      • userAgent string (optional)
      • createdAt string (date-time ISO 8601)
      • updatedAt string (date-time ISO 8601)
    • source string (optional)
    • text string (optional)
  • type enum (newsletter-subscribed)