Exclusion Lists

Overview

The Exclusion Lists endpoint allows you to manage your Exclusion Lists, by creating new Exclusion Lists, or by requesting information about or updating existing Exclusion Lists. You can also manage the members within an Exclusion List.

For more details on how to set up an Exclusion Lists API request, please see the Exclusion Lists API Technical Guide.

• North America:

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

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

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

• Europe:

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

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

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

• Japan:

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

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

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

GET Method

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

Retrieve All Items

This endpoint allows you to retrieve a list of all available Exclusion Lists (including both Virtual and Standard Exclusion Lists) in your account; you can optionally filter and sort this list to narrow down the results. The endpoints for this method are:

 

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 Exclusion List by providing its Object Reference ID. This Exclusion List can be either a Virtual or a Standard Exclusion List.  

 

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

 

Retrieve Members

This endpoint allows you to retrieve a list of the members in a single Exclusion List by providing its Object Reference ID. This endpoint is intended for use only with Standard Exclusion Lists.

 

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

 

POST Method

This endpoint allows you to create a new Standard Exclusion List. Within the request message, you must provide the following:

• The name of the Exclusion List.

• The status of the Exclusion List -- 'READY' or 'DRAFT.'

• The channel -- 'EMAIL,' 'SMS,' or 'PUSH.'

Note: You can't create a new Virtual Exclusion List via this endpoint; only Standard Exclusion Lists are supported.

Please note that when you create an Exclusion List through the API endpoint, the Exclusion List will initially be "empty" with no members contained within it. To manage the members in the Exclusion List, 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 request message in JSON format.

 

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 Exclusion List.

Update Exclusion List Information

This endpoint allows you to update the information about an Exclusion List, such as its name, channel, or status. This Exclusion List can be either a Virtual or a Standard Exclusion List. You must provide the Object Reference ID of the existing Exclusion List. The message must then provide the details of what you want to change.

 

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

 

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

 

Replace Exclusion List Members

This endpoint allows you to replace all existing members in the Exclusion List with one or more members provided in the API request message. You must provide the Object Reference ID of the existing Exclusion List, as well as the details of the new members. This endpoint is intended for use only with Standard Exclusion Lists.

Please, note that this endpoint will delete any existing members in the Exclusion List. The request message must include the contact information for the new members (email address for Email, mobile phone number for SMS Text, or Push Registration IDs for Push Notification).

 

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

 

PATCH Method

The PUT method described above allows you to completely replace a list of members in a Standard Exclusion List. The PATCH method gives you more flexibility -- you can insert new members into an Exclusion List, or you can remove existing members . You must provide the Object Reference ID of the Exclusion List that you want to modify. This endpoint is intended for use only with Standard Exclusion Lists.

If inserting new members, the request message must include the contact information for the new members (email address for Email, mobile phone number for SMS Text, or Push Registration IDs for Push Notification).

If deleting existing members, the request message must include the contact information for the existing members. Also, you must set the "remove" parameter to "TRUE."

 

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

 

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.5.0  May 2024