Overview

Distribution lists are address books that can be used for sending a QuickLink to a pre-determined group of people.

Lists can contain named (registered) users or just emails.

JSON

{
  "id": "53ad8d3fe4b008e4d4426fec",
  "ownerId": "B16E557C-A918-F507-152C40EE820197A9",
  "name": "Boston Office",
  "description": "Our Boston Team",
  "recipients": [
    {
      "firstName": "Ken",
      "lastName": "Jones",
      "email": "[email protected]",
      "userId": "bf33b7fc-53f1-4517-bd36-afe5ce45add5"
    },
    {
      "firstName": "Janet",
      "lastName": "Grouch",
      "email": "[email protected]",
      "userId": "c84560b3-cccd-4da5-a9e4-2fd98937f681"
    },
    {
      "email": "[email protected]"
    }
  ]
}

{
  "name": "Boston Office",
  "description": "Boston.",
  "recipients": [
    {
      "firstName": "Ken",
      "lastName": "Jones",
      "email": "[email protected]",
      "userId": "bf33b7fc-53f1-4517-bd36-afe5ce45add5"
    },
    {
      "firstName": "Janet",
      "lastName": "Grouch",
      "email": "[email protected]",
      "userId": "c84560b3-cccd-4da5-a9e4-2fd98937f681"
    },
    {
      "email": "[email protected]"
    }
  ]
}

Payload

Distribution lists require a name and an array of recipients.

Attribute	Type	Description
name	string	Required. Name of the distribution list (e.g. "Producers", "Editors", "Stakeholders").
description	string	Optional. A brief description of the list.
recipients	array	Required. An array of email recipient objects (see below).

When submitting an array of recipients, use the following format:

Attribute	Type	Description
firstName	string	Optional. First name of recipient; will be automatically added if userId is used.
lastName	string	Optional. Last name of recipient; will be automatically added if userId is used.
email	string	Required (no duplicates). Email address; will be automatically added if userId is used.
userId	string	Optional. User ID, if the recipient is a MediaSilo user.

Distribution lists are user specific and cannot be shared across users or accounts.