SharePoint - Update user alert
Declaration
<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="text" USER="text" ID="text" TITLE="text" TYPE="text (options)" EVENT="text (options)" FREQUENCY="text (options)" />
Description
Updates the settings and content of an existing user alert.
NOTE:
- This activity only supports SharePoint 2016 and 2019 Server with the 64-bit version of Automate Desktop.
- SharePoint-related error messages appearing in Automate Desktop are sent from your SharePoint site or server. Automate Desktop displays these messages verbatim. For information on SharePoint error messages, refer to Microsoft's SharePoint documentation.
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 update a user alert for yourself or for other people if you are a site administrator.
Parameters
Server
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Site | Text | Yes | (Empty) | SITE="http:/yServer/h/mi" | The SharePoint site from which to modify a user alert. |
User | Text | Yes | (Empty) | USER="theUser"" | Specifies how to identify the user to modify a user alert for. The available options are:
|
User alert ID | Text | Yes | (Empty) | ID="D1F15740-4A56-4681-8C12-1DFBF346323B" | The unique identifier of the alert to modify. |
Title | Text | No | (Empty) | TITLE="theAlert" | The name of the alert in which to modify. |
Type | Text (options) | No | Doesn't matter |
|
The
type of alert to send. The available options are:
|
Event | Text (options) | No | Doesn't matter |
|
The type
of event
to which the alert applies. The available
options are:
|
Frequency | Text (options) | No | Doesn't matter |
|
The frequency
in which the alert should be sent. The available options are:
|
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task updates a SharePoint user alert.
Copy
<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="http://myServer/myFolder" USER="me@myDaomain.com" USERFILTER="email" ID="D1F15740-4A56-4681-8C12-1DFBF346323B"" TITLE="myAlert" TYPE="email" EVENT="delete" FREQUENCY="daily" />