Message Opt-in

API-based (server-side) event: Reconnect push notifications only

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:

Example of API event

{ 
  "user": { 
  "dyid": "-4350463893986789401", 
  "dyid_server": "-4350463893986789401" 
  }, 
  "session": { 
    "dy": "ohyr6v42l9zd4bpinnvp7urjjx9lrssw" 
   }, 
 "events": [ 
  { 
    "name": "Push Opt-In", 
    "properties": { 
      "dyType": "message-optin-v1", 
      "pushID": "100" 
    } 
  } 
 ] 
}

Example of event for API-only type section

{ 
  "user": { 
    "id": "john_123" 
  }, 
  "sessionId": "iquahngaishe2koh", 
  "events": [ 
    { 
      "name": "Push Opt-In", 
      "properties": { 
        "dyType": "message-optin-v1", 
        "pushID": "100" 
      } 
    } 
  ] 
}

👍

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

Script-based (client-side) event: Reconnect email messages only

🚧

We strongly recommend that you manage your opted-in email users via feed, not script event.

Mark individual users email addresses to receive or not receive Reconnect emails. The email recipient list is managed by Dynamic Yield using these events.

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:

Example: Implementation via script using a hashed email address

DY.API("event", {
  name: "Message Opt In",
  properties: {
    dyType: "message-optin-v1",
    cuidType: "email",
    plainTextEmail: "[email protected]"
  }
});

Example: Implementation via script using an external ID

DY.API("event", {
  name: "Message Opt In",
  properties: {
    dyType: "message-optin-v1",
    cuidType: "external",
    externalId:"852456456"
  }
});