POST /messaging/v1/email/seed-lists/

Overview

Creates a seed-list for an account. The MID and Partner AppId is used from authentication. There's a retention period of 60 days for the seed-list. To stay active, update seed lists every 30 days, even when they're unchanged. An account can have 20 seed-lists, and each seed-list is allowed 500 seeds.

JSON Parameters

Name Type       Description
name string     Required Names the seed-list to be created.
description string       If the name doesn't fully describe the seed-list, a description is provided.
seeds array of objects     Required Holds a list of objects, each containing a single name:value pair.
    Name Type    
    email string Required Each record, up to and including 500, contains a valid email address of the seed.

Response

Status Name Type Description
201     Successful creation of a seed list
  id string A globally unique identifier (GUID)

Validation Failure Scenarios

HTTP Status Description
400 The proposed seed-list name exists already.
400 Partner App has 20 active seed-lists.
400 The request has more than 500 seeds
400 The seed-list name is longer than 128 characters.
400 An email address under seeds is incorrect in format.
401 The request comes from an invalid partner app.
429 API rate limit throttling is preventing success.

Usage

Example Request

POST /messaging/v1/email/seed-lists/
{
    "name": "seedList1Name",
    "description" : "some description",
    "seeds":[
        {"email": "address1@example.com"},
        {"email": "address2@example.com"},
        {"email": "address3@example.com"}
    ]
}

Example Response

201 Created
{
   "id": "20e173cd-12aa-45e5-bd1f-b425730f39c6"
}

Related Items