Get alert templates

Retrieve a list of alert templates.

The payload type is

GET-SCENARIOS

The payload content is optional; it is used to filter the list of alert templates returned in the response.

Alert templates were previously called scenarios.

If included, it should be in the following format:

<scenarios>
<channel>channelCommonName</channel>
<keywords>searchString</keywords>                   
<availableInHomePage>Y|N</availableInHomePage>                    
<availableInPublisher>Y|N</availableInPublisher>
<availableForMobile>Y|N</availableForMobile>                     
</scenarios>

<SCENARIOS> Nodes

Tag	Mandatory	Description
<channel>	No	Filter the list of alert templates by alert folder.
<keywords>	No	Filter the list of alert templates by searching for the keyword in the template name, title, and body text.
<availableInHomePage>	No	Value options: Y : The returned list of alert templates includes only those that are available for publishing on the Home Page. N : The returned list of alert templates includes all alert templates.
<availableInPublisher>	Deprecated	Value options: Y : The returned list of alert templates includes only those that are available for publishing in the Quick Publisher. N : The returned list of alert templates includes only those that are not available for publishing in the Quick Publisher.
<availableForMobile>	No	Value options: Y : The returned list of alert templates includes those that are available for publishing to the Mobile app. N : The returned list of alert templates includes those that are available for the organization.

The following is a sample SDK response:

<scenarios>                    
<scenario id="scenarioId"/>       
<name />          
<commonName />          
<alertTitle />
<availableInHomePage />
<availableInPublisher />
<availableForMobile/>                
<createdBy/>                        
<createdOn/>
<updatedBy/>
<updatedOn/>
<metaStore />
<channel id="">
<name />
<commonname />
</channel>
</scenario>
…
</scenarios>

GET-SCENARIOS SDK requests and responses are internationalization-enabled. For a list of supported Windows 1252 characters, see Internationalization-supported characters.

Section:

Content APIs