Skip to main content

Notification schedules are deleted by issuing a SetNotificationPreferences call with related parameters appropriately configured.

To delete all schedules for a user, set EventEnable to Disable, and omit SummarySchedule from the UserData container.

Alternatively, omit UserData from the call to SetNotificationPreferences.

Examples

Delete All Schedules

SetNotificationPreferences: Deleting All 

<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Disable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>

Delete a Schedule by SummaryPeriod and Frequency

To delete a specific schedule, set UserData.SummarySchedule.EventType to AccountSummary, and set SummaryPeriod and Frequency to match the schedule to be deleted.

The following example deletes the EveryMonday, Last31Days schedule for the user.

SetNotificationPreferences: Deleting Selected 

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

Delete a Schedule by Specified Frequency

To delete all schedules matching a particular frequency regardless of summary period, set Frequency to that particular frequency and omit SummaryPeriod.

The following example deletes all of the user's schedules for Monday.

SetNotificationPreferences: Deleting Selected 

<UserDeliveryPreferenceArray>
  <NotificationEnable>
    <EventType>AccountSummary</EventType>
    <EventEnable>Disable</EventEnable>
  </NotificationEnable>
</UserDeliveryPreferenceArray>
<UserData>
  <SummarySchedule>
    <EventType>AccountSummary</EventType>
    <Frequency>EveryMonday</Frequency>
  </SummarySchedule>
</UserData>

Delete a Schedule by Specified SummaryPeriod

Similarly, you can delete all schedules matching a SummaryPeriod by providing SummaryPeriod and omitting Frequency.