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

Overview

Update a single seed list for an account. The MID and partner appId are used from authentication. The {id} in the URL path is the globally unique ID assigned by the system at creation.

A seed-list is retained for 60 days. To keep them active, update seed lists every 30 days, even when they're unchanged. Any seed-lists existing before this call are replaced by the ones provided in the JSON payload. An account can have 20 seed-lists, and each seed-list is allowed 500 seeds.

JSON Parameters

Name Type     Description
name string     The name given at creation or update.
description string     A description of the seed-list.
seeds list of objects     The objects in the list each consist of a single name:value pair.
    Name Type  
    email string an email address.

Response

Status Name Type     Description
200         Successful response indicating the request passed validations.
  name string     The name given at creation or update.
  description string     A description of the seed-list.
  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 ID.
429 API rate limit throttling is preventing success.

Usage

Example Request

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

Example Responses

200 OK
{
    "id": "fb9a8b12-a088-4999-b9ce-f8cd3fe06386",
}
200 OK
{}

Related Items