{"_id":"54b54f903157eb2a0053c6f4","editedParams2":true,"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"},"__v":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","user":"54343147fa5527080064f43f","editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-01-13T17:02:08.684Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[]},"auth":"required","params":[{"_id":"54b54f903157eb2a0053c6f5","ref":"","in":"path","required":true,"desc":"The list you are editing","default":"","type":"string","name":"listId"},{"_id":"54b5470296fe3c0b00d38d1d","ref":"","in":"body","required":false,"desc":"Name of the distribution list (e.g. \"Producers\", \"Editors\", \"Stakeholders\").","default":"","type":"string","name":"name"},{"_id":"54b5470296fe3c0b00d38d1c","ref":"","in":"body","required":false,"desc":"A brief description of the list.","default":"","type":"string","name":"description"},{"_id":"54b5470296fe3c0b00d38d1b","ref":"","in":"body","required":false,"desc":"An array of email recipient objects.","default":"","type":"array_mixed","name":"recipients"}],"url":"/distributionlists/:listId"},"isReference":false,"order":4,"body":"In order to edit the recipients in a distribution list you must post the complete list of recipients.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"firstName\\\": \\\"Big\\\",\\n    \\\"lastName\\\": \\\"Bird\\\",\\n    \\\"email\\\": \\\"thebigbyrd:::at:::sesamestreet.org\\\",\\n    \\\"userId\\\": \\\"bf33b7fc-53f1-4517-bd36-afe5ce45add5\\\"\\n  },\\n  {\\n    \\\"firstName\\\": \\\"Oscar\\\",\\n    \\\"lastName\\\": \\\"Grouch\\\",\\n    \\\"email\\\": \\\"leavemealone@sesamestreet.org\\\",\\n    \\\"userId\\\": \\\"c84560b3-cccd-4da5-a9e4-2fd98937f681\\\"\\n  },\\n  {\\n    \\\"email\\\": \\\"mspiggy@themuppetshow.org\\\"\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"API Test\",\n  \"body\": \"Due to the limitation of the API test widget, it is currently not possible to submit an array of recipients for testing. We suggest using PostMan or a similar tool to test endpoints that require an array of objects to be submitted.\"\n}\n[/block]","excerpt":"Edits an existing distribution list","slug":"edit-list","type":"endpoint","title":"Edit List"}

putEdit List

Edits an existing distribution list

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

listId:
required
string
The list you are editing

Body Params

name:
string
Name of the distribution list (e.g. "Producers", "Editors", "Stakeholders").
description:
string
A brief description of the list.
recipients:
array of mixed
An array of email recipient objects.

Documentation

In order to edit the recipients in a distribution list you must post the complete list of recipients. [block:code] { "codes": [ { "code": "{\n \"firstName\": \"Big\",\n \"lastName\": \"Bird\",\n \"email\": \"thebigbyrd@sesamestreet.org\",\n \"userId\": \"bf33b7fc-53f1-4517-bd36-afe5ce45add5\"\n },\n {\n \"firstName\": \"Oscar\",\n \"lastName\": \"Grouch\",\n \"email\": \"leavemealone@sesamestreet.org\",\n \"userId\": \"c84560b3-cccd-4da5-a9e4-2fd98937f681\"\n },\n {\n \"email\": \"mspiggy@themuppetshow.org\"\n }", "language": "json" } ] } [/block] [block:callout] { "type": "danger", "title": "API Test", "body": "Due to the limitation of the API test widget, it is currently not possible to submit an array of recipients for testing. We suggest using PostMan or a similar tool to test endpoints that require an array of objects to be submitted." } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}