Message Opt-out

👍

New dedicated Opt-in/Opt-out endpoints for Reconnect

Reconnect now has its own Update Reconnect Opt-In and Update Reconnect Opt-Out server-side API events.

If you're already using Message Opt-in or Message Opt-out events, no worries—we'll continue to support them. However, if you're setting up your implementation now, use the dedicated APIs.

Learn more about implementing Reconnect Update events in email and SMS integrations

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-Out", 
    "properties": { 
      "dyType": "message-optout-v1", 
      "pushID": "100" 
    } 
  } 
 ] 
}

Example of event for API-only type section

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

👍

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

Script-based (client-side) event: Reconnect email messages 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: Implementation via script using a plain text email address

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

Example: Implementation via script using an external ID

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