Seed Lists

Overview

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

For more details on how to set up a Seed List API request, please see the Seed Lists API Technical Guide.

  • North America:

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

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

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

  • Europe:

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

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

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

  • Japan:

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

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

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

GET Method

The Seed Lists endpoint supports the following GET operations. These operations are intended to retrieve information about an existing Seed List.

Retrieve All Items

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

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

Retrieve a Single Item

This endpoint allows you to retrieve information about a single Seed List by providing its Object Reference ID as a path parameter in the URL. For example:

https://api.eccmp.com/services2/api/SeedLists/2825

Click 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 Seed List by providing its Object Reference ID as a path parameter in the URL. For example:

https://api.eccmp.com/services2/api/SeedLists/2825/Recipients

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

POST Method

The Seed Lists endpoint allows you to create a new Seed List. Within the request message, you must provide the following:

  • The name of the new Seed List.

  • The Table Name for the source table.

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

  • Optionally, any Tags you want to assign to the Seed List.

Please note that when you create a Seed List through the API endpoint, the Seed List will initially be "empty." To manage the recipients in the Seed List, you'll need to submit a second API request message, using the PUT or PATCH methods described below.

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

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

PUT Method

The Seed List endpoint supports the following PUT operations. These operations are intended to update the information about an existing Seed List.

Update Seed List Information

Thisendpoint allows you to update the information about a Seed List, such as its name, table, or status. You must provide the Seed List's Object Reference IDas a path parameter in the URL. For example:

https://api.eccmp.com/services2/api/SeedLists/2825

In the body of the message, provide the details of what you want to change.

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

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

Replace Seed List Recipients

Thisendpoint allows you to replace all existing recipients in the Seed List with one or more recipients provided in the API request message. If you want to insert, or remove, individual recipients, you must instead use the PATCH method described below.

When doing a full replace of the Seed List recipients, you must provide the Seed List's Object Reference IDas a path parameter in the URL. For example:

https://api.eccmp.com/services2/api/SeedLists/2825/Recipients

In the body of the message, provide the contact details for the new recipients. Please, note that this endpoint will delete any existing recipients in the Seed List.  

Click 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 recipients in a Seed List. The PATCH method gives you more flexibility -- you can insert new recipients into a Seed List, or you can remove existing recipients. When inserting or removing recipients, you must provide the Seed List's Object Reference IDas a path parameter in the URL.

In addition, you must use the "remove" parameter as a query parameter in the URL to indicate if you're removing or inserting recipients. A value of "true" will remove a recipient; value of "false" will insert a recipient. If you don't provide a value for this parameter, the system will default to "false." For example:

https://api.eccmp.com/services2/api/SeedLists/2825/Recipients?remove=true

If inserting new recipients, the request message must include the contact information for the new recipients. If deleting existing recipients, the request message must include the contact information for the existing recipients.  

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