Developer Guide
Visit our Knowledge BaseRequest a Demo

Newsletter Subscription

Reports that a user signed up for a newsletter. Identification event.

Suggest Edits

Report this event to track subscriptions (regardless of whether the user has an account) and associate the anonymous user ID with the hashed email address entered by the user. This event does not accept custom user ID types, and its main use is to enable personalized email features.

Parameters

  • name: Human-readable name, not used to identify an event type
  • properties: A container for the event properties as specified in the following table:
PropertyDescriptionType
dyTypeMust be "newsletter-subscription-v1"String
cuidUser identifier value.
! Must not include a / character		String
cuidType
Use this identifier type to identify users across devices (for example, customer_id, account_id, or hefor SHA-256 hashed email). Note: Do not include any personal information in this ID.String
secondaryIdentifiers
type, value		Optionally, add a second method for identification across devices and Experience OS apps. Your secondary identifier can be anything you decide, including a hashed email address, phone number, CRM ID, e-commerce ID, and so on. You must define the identifier type in your section settings .

If you decide to use a phone number as the secondary identifier, handle it as follows:
Script-based event: Type: phoneNumber, Value: Phone number
Must be E.164 format (+ and country code and phone number, no spaces or symbols. For example, +12195551212, +49555343333.)
API-based event: Type: hashedPhoneNumber, Value: SHA-256 hashed phone number		String
Note:
Identifiers with special requirements		 Hashed email (he) and hashed phone number (hashedPhoneNumber) must use SHA-256 hashing.
Phone number (phoneNumber) must conform to the E.164 format. Contact your technical account manager to enable using phoneNumber as an identifier in your script-based events.

📌

Using the secondary identifier

As soon as you report a secondary identifier for a user, that ID is mapped to the user no matter which device is used or which event is reported. Until it's overriden with a new value, it exists for the user whether or not it's re-reported in an API or script-based event.

👍

TIP: Using hashedEmail instead of cuid and cuidType

You can use a sort of "shorthand" in your event code to replace these 2 properties with a single one if the CUID type is hashed email address. See examples that follow for how this can look.

hashedEmail
Optional		SHA-256 encoding of the lowercase email address. You can use this identifier type instead of cuid and cuidType.String

Example: Implementation via script, using cuid:

DY.API("event", {
  name: "Newsletter Subscription",
  properties: {
    dyType: "newsletter-subscription-v1",
    cuid: "156498191",
    cuidType: "EcommerceID"
  }
});

Example: Implementation via script, using hashed email address

DY.API("event", {
  name: "Newsletter Subscription",
  properties: {
    dyType: "newsletter-subscription-v1",
    hashedEmail: "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
  }
});

Example: Implementation via script, using secondary identifiers

DY.API("event", {
  name: "Newsletter Subscription",
  properties: {
    dyType: "newsletter-subscription-v1",
     cuid: "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1",
    cuidType: "he",
    secondaryIdentifiers: [
      { type: "phoneNumber", value: "+12195551212" },
      { type: "ecommerceID", value: "12345" },
      { type: "vipClub", value: "678910" }
    ]
  }
});

Example: Implementation via Experience API (server-side), using cuid

 "events":[
        {
  "name": "Newsletter Subscription",           
  "properties": {
  "dyType": "newsletter-subscription-v1",
  "cuidType": "clientId",
  "cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
          }
        }
      ]

Example: Implementation via Experience API (server-side), using hashed email address

״events״:[
  {           
  "name": "Newsletter Subscription",           
  "properties": {
   "dyType": "newsletter-subscription-v1",
   "hashedEmail": "43e62d636651bc44edcd528a510d57ce69126cd875c..."           
  }
} ]

Example: Implementation via Experience API, using secondary identifiers

"event":[
  {
 "name": "Newsletter Subscription",
 "properties": {
    "dyType": "newsletter-subscription-v1",
   "cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1",
        "cuidType": "clientId",
        "secondaryIdentifiers": [
          { "type": "hashedPhoneNumber", "value": "49c7b1f6d24121078d8f37997b433586fe9a28e2dc4fbd0803eac237ac82255e" },
          { "type": "ecommerceID", "value": "12345" },
          { "type": "vipClub", "value": "678910" }
        ]
      }
    }
  ]

👍

Go to the API reference for the Events endpoint to learn more.

Updated 24 days ago