SharePoint - Delete User Alert

Declaration

<AMSHAREPOINT ACTIVITY="delete_useralert" SITEURL="text" 
USER="text" ID="text" />

Description: Deletes a specific alert assigned to a user identified by the Alert ID.

NOTE: This activity is only supported on SharePoint 2013 Server. Before users and alerting administrators can create, edit, delete, and view data alerts, they must be granted SharePoint permissions.

Practical Usage

Alerts are notifications of changes to content on a site that you receive as email messages or text messages to your mobile phone.This activity allows you to delete a user alert for yourself or for other people if you are a site administrator.

Connection Parameters

Property

Type

Required

Default

Markup

Description

Site Text Yes (Empty) SITE="http://myServer/folder" The SharePoint site from which to delete a user alert. A SharePoint site is a collection of pages, site templates, lists, and libraries configured for the purpose of achieving an express goal.
User Text Yes (Empty) USER="theUser" The user from which to delete a user alert. The user can be identified by his/her login name or email address.
User alert ID Text Yes (Empty) ID="D1F15740-4A56-4681-8C12-1DFBF346323B" The unique identifier of the alert to delete.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Delete user alert with ID "D1F15740-4A56-4681-8C12-1DFBF346323B". SharePoint site user is "jd@domain.com".

<AMSHAREPOINT ACTIVITY="delete_useralert" SITEURL="http://myServer/folder" 
USER="jd@domain.com" ID="D1F15740-4A56-4681-8C12-1DFBF346323B&quot;" />