GET /messaging/v1/email/seed-lists/{id}

Overview

Read a single seed list for an account. The MID and partner appId is used from authentication. Ensure the MID is activated for MCSeedList. This query verifies that the seed-list GUID given as the value for id belongs to the appID. If so, it returns the active seed-list for the id.

Response

Status Name Type     Description
200         Successful response indicating the request passed validations
  id string     The globally unique id (GUID) assigned inception.
  name string     The description given at creation or update.
  description string     The description of the seed-list given at creation or update.
  seeds list of objects     The objects in the list each consist of a single name:value pair.
      Name Type  
      email string An email address.
200         Successful response but with an empty object, indicating no active seed-lists for the partner appID.

Validation Failure Scenarios

HTTP Status Description
401 Seed-list doesn't belong to the partner appID.
429 API rate limit throttling is preventing success.

Usage

Example Request

GET /messaging/v1/email/seed-lists/{id}

Example Responses

Data exists:

200 OK
{
    "id": "fb9a8b12-a088-4999-b9ce-f8cd3fe06386",
    "name": "seedList1Name",
    "description": "Seed list description",
    "seeds": [
        {"email": "address1@example.com"},
        {"email": "address2@example.com"},
        {"email": "address3@example.com"}
    ]
}

No data exists:

200 OK
{}

Related Items