Alert Groups

Overview

The Alert Group endpoint allows you to manage your Alert Groups, by creating new Alert Groups, or by requesting information about or updating existing Alert Groups. You can also manage the recipients within an Alert Group.

For more details on how to set up an Alert Group API request, please see the Alert Groups API Technical Guide.

• North America:

• https://api.eccmp.com/services2/api/AlertGroups

• https://api.eccmp.com/services2/api/AlertGroups/{id}

• https://api.eccmp.com/services2/api/AlertGroups/{id}/Recipients

• Europe:

• https://api.ccmp.eu/services2/api/AlertGroups

• https://api.ccmp.eu/services2/api/AlertGroups/{id}

• https://api.ccmp.eu/services2/api/AlertGroups/{id}/Recipients

• Japan:

• https://api.marketingsuite.jp/services2/api/AlertGroups

• https://api.marketingsuite.jp/services2/api/AlertGroups/{id}

• https://api.marketingsuite.jp/services2/api/AlertGroups/{id}/Recipients

GET Methods

This endpoint supports the following GET operations. These operations are intended to retrieve information about an existing Alert Group.

Retrieve All Items

This endpoint allows you to retrieve a list of all available Alert Groups in your account; you can optionally filter and sort this list to narrow down the results.  

 

Click hereClick here to see a sample response message in JSON format.

 

Retrieve a Single Item

This endpoint allows you to retrieve information about a single Alert Group by providing its Object Reference ID.  

 

Click hereClick here to see a sample response message in JSON format.

 

Retrieve Recipients

This endpoint allows you to retrieve a list of the recipients in a single Alert Group by providing its Object Reference ID.

 

Click hereClick here to see a sample response message in JSON format.

 

POST Method

This endpoint allows you to create a new Alert Group. Within the request message, you must provide the name of the Alert Group, the name of the source table, the status, the channel (Alert Groups can be used in the email, SMS text, or Push Notification channels), and optionally any Tags that you want to assign to the Group.

Please note that when you create an Alert Group through the API endpoint, the system will automatically add you as a member of the Group, and include your contact information. To manage any other recipients in the Alert Group, you'll need to submit a second API request message, using the PUT or PATCH methods described below.

 

Click hereClick here to see a sample response message in JSON format.

 

PUT Methods

This endpoint supports the following PUT operations. These operations are intended to update the information about an existing Alert Group.

Update Alert Group Information

This endpoint allows you to update the information about an Alert Group, such as its name, status, or source table. You must provide the Object Reference ID of the existing Alert Group, as well as its current channel type (you can't change the channel type). The message must then provide the details of what you want to change.

 

Click hereClick here to see a sample response message in JSON format.

 

Replace Alert Group Recipients

This endpoint allows you to replace all existing recipients in the Alert Group with one or more recipients provided in the API request message. You must provide the Object Reference ID of the existing Alert Group, as well as the details of the new recipients. Please, note that this endpoint will delete any existing recipients in the Alert Group. The request message must include the contact information for the new recipients (email address for email or Push Notification Alert Groups, or mobile phone number for SMS Text Alert Groups), as well as the content type (plain text or multipart) for each one.

 

Click hereClick here to see a sample response message in JSON format.

 

PATCH Method

The PUT method described above allows you to completely replace a list of recipients in an Alert Group. The PATCH method gives you more flexibility -- you can insert new recipients into an Alert Group, or you can remove existing recipients. You must provide the Object Reference ID of the Alert Group that you want to modify.

If inserting new recipients, the request message must include the contact information for the new recipients (email address for email or Push Notification Alert Groups, or mobile phone number for SMS Text Alert Groups), as well as the content type (plain text or multipart).

If deleting existing recipients, the request message must include the contact information for the existing recipients, as well as the existing content type. Also, you must set the "remove" parameter to "TRUE."

 

Click hereClick here to see a sample response message in JSON format.

 

Back to API Category - Campaign Management

 

 Copyright © Marigold    Marigold Engage+ Online Help v24.8.0  August 2024