{"_id":"54b5429c3157eb2a0053c6dc","__v":1,"parentDoc":null,"user":"54343147fa5527080064f43f","version":{"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","__v":27,"forked_from":"54343170fa5527080064f44c","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"category":{"_id":"54b533a3a806f40c0050d53c","project":"54343170fa5527080064f449","__v":6,"version":"54343531bfaa3d0800c4d4af","pages":["54b5429c3157eb2a0053c6dc","54b543a296fe3c0b00d38d06","54b5470296fe3c0b00d38d1a","54b54f903157eb2a0053c6f4","54b550833157eb2a0053c6f6","54b5835396fe3c0b00d38d9b"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-13T15:02:59.616Z","from_sync":false,"order":12,"slug":"distribution-lists","title":"Distribution Lists"},"project":"54343170fa5527080064f449","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-01-13T16:06:52.557Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Distribution lists are address books that can be used for sending a QuickLink to a pre-determined group of people. \n\nLists can contain named (registered) users or just emails.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"53ad8d3fe4b008e4d4426fec\\\",\\n  \\\"ownerId\\\": \\\"B16E557C-A918-F507-152C40EE820197A9\\\",\\n  \\\"name\\\": \\\"Boston Office\\\",\\n  \\\"description\\\": \\\"Our Boston Team\\\",\\n  \\\"recipients\\\": [\\n    {\\n      \\\"firstName\\\": \\\"Ken\\\",\\n      \\\"lastName\\\": \\\"Jones\\\",\\n      \\\"email\\\": \\\"ken:::at:::mediamakers.com\\\",\\n      \\\"userId\\\": \\\"bf33b7fc-53f1-4517-bd36-afe5ce45add5\\\"\\n    },\\n    {\\n      \\\"firstName\\\": \\\"Janet\\\",\\n      \\\"lastName\\\": \\\"Grouch\\\",\\n      \\\"email\\\": \\\"janet@mediamakers.com\\\",\\n      \\\"userId\\\": \\\"c84560b3-cccd-4da5-a9e4-2fd98937f681\\\"\\n    },\\n    {\\n      \\\"email\\\": \\\"larry@mediamakers.com\\\"\\n    }\\n  ]\\n}\\n\\n{\\n  \\\"name\\\": \\\"Boston Office\\\",\\n  \\\"description\\\": \\\"Boston.\\\",\\n  \\\"recipients\\\": [\\n    {\\n      \\\"firstName\\\": \\\"Ken\\\",\\n      \\\"lastName\\\": \\\"Jones\\\",\\n      \\\"email\\\": \\\"ken@mediamakers.com\\\",\\n      \\\"userId\\\": \\\"bf33b7fc-53f1-4517-bd36-afe5ce45add5\\\"\\n    },\\n    {\\n      \\\"firstName\\\": \\\"Janet\\\",\\n      \\\"lastName\\\": \\\"Grouch\\\",\\n      \\\"email\\\": \\\"janet@mediamakers.com\\\",\\n      \\\"userId\\\": \\\"c84560b3-cccd-4da5-a9e4-2fd98937f681\\\"\\n    },\\n    {\\n      \\\"email\\\": \\\"larry@mediamakers.com\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Payload\"\n}\n[/block]\nDistribution lists require a name and an array of recipients.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Required. Name of the distribution list (e.g. \\\"Producers\\\", \\\"Editors\\\", \\\"Stakeholders\\\").\",\n    \"1-0\": \"description\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Optional. A brief description of the list.\",\n    \"2-0\": \"recipients\",\n    \"2-1\": \"array\",\n    \"2-2\": \"Required. An array of email recipient objects (see below).\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\nWhen submitting an array of recipients, use the following format:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"firstName\",\n    \"0-1\": \"string\",\n    \"1-0\": \"lastName\",\n    \"1-1\": \"string\",\n    \"2-0\": \"email\",\n    \"3-0\": \"userId\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"0-2\": \"Optional. First name of recipient; will be automatically added if userId is used.\",\n    \"1-2\": \"Optional. Last name of recipient; will be automatically added if userId is used.\",\n    \"2-2\": \"Required (no duplicates). Email address; will be automatically added if userId is used.\",\n    \"3-2\": \"Optional. User ID, if the recipient is a MediaSilo user.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nDistribution lists are user specific and cannot be shared across users or accounts.","excerpt":"","slug":"overview-6","type":"basic","title":"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. [block:code] { "codes": [ { "code": "{\n \"id\": \"53ad8d3fe4b008e4d4426fec\",\n \"ownerId\": \"B16E557C-A918-F507-152C40EE820197A9\",\n \"name\": \"Boston Office\",\n \"description\": \"Our Boston Team\",\n \"recipients\": [\n {\n \"firstName\": \"Ken\",\n \"lastName\": \"Jones\",\n \"email\": \"ken@mediamakers.com\",\n \"userId\": \"bf33b7fc-53f1-4517-bd36-afe5ce45add5\"\n },\n {\n \"firstName\": \"Janet\",\n \"lastName\": \"Grouch\",\n \"email\": \"janet@mediamakers.com\",\n \"userId\": \"c84560b3-cccd-4da5-a9e4-2fd98937f681\"\n },\n {\n \"email\": \"larry@mediamakers.com\"\n }\n ]\n}\n\n{\n \"name\": \"Boston Office\",\n \"description\": \"Boston.\",\n \"recipients\": [\n {\n \"firstName\": \"Ken\",\n \"lastName\": \"Jones\",\n \"email\": \"ken@mediamakers.com\",\n \"userId\": \"bf33b7fc-53f1-4517-bd36-afe5ce45add5\"\n },\n {\n \"firstName\": \"Janet\",\n \"lastName\": \"Grouch\",\n \"email\": \"janet@mediamakers.com\",\n \"userId\": \"c84560b3-cccd-4da5-a9e4-2fd98937f681\"\n },\n {\n \"email\": \"larry@mediamakers.com\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Payload" } [/block] Distribution lists require a name and an array of recipients. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "string", "0-2": "Required. Name of the distribution list (e.g. \"Producers\", \"Editors\", \"Stakeholders\").", "1-0": "description", "1-1": "string", "1-2": "Optional. A brief description of the list.", "2-0": "recipients", "2-1": "array", "2-2": "Required. An array of email recipient objects (see below)." }, "cols": 3, "rows": 3 } [/block] When submitting an array of recipients, use the following format: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "firstName", "0-1": "string", "1-0": "lastName", "1-1": "string", "2-0": "email", "3-0": "userId", "2-1": "string", "3-1": "string", "0-2": "Optional. First name of recipient; will be automatically added if userId is used.", "1-2": "Optional. Last name of recipient; will be automatically added if userId is used.", "2-2": "Required (no duplicates). Email address; will be automatically added if userId is used.", "3-2": "Optional. User ID, if the recipient is a MediaSilo user." }, "cols": 3, "rows": 4 } [/block] Distribution lists are user specific and cannot be shared across users or accounts.