Skip to main content

Notification schedules are added/updated by issuing a SetNotificationPreferences call with related parameters appropriately configured.

Use SummarySchedule in combination with UserDeliveryPreferenceArray.NotificationEnable to set:

  • EventType to AccountSummary
  • EventEnable to Enable
  • Also set:
    • UserData.SummarySchedule.EventType to AccountSummary
    • SummaryPeriod to the desired value
    • Frequency to the desired value

Example

The following example creates a new schedule for a user where every Monday a summary of the last 31 days' activities is delivered.

SetNotificationPreferences: Creating/Adding 

<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Enable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>
<UserData>
  <SummarySchedule>
    <EventType>AccountSummary</EventType>
    <SummaryPeriod>Last31Days</SummaryPeriod>
    <Frequency>EveryMonday</Frequency>
  </SummarySchedule>
</UserData>