{"componentChunkName":"component---src-templates-api-js","path":"/api/recipient-lists/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Recipient Lists API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage recipient lists, collections of recipients that can be used when sending messages."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Recipient Lists"}},"content":[{"element":"copy","content":"A recipient list is a collection of recipients that can be used in a transmission.  The Recipient\nList API provides the means to manage recipient lists.  When creating a new\ntransmission using the Transmissions API, the recipients may be submitted \"inline\" as part of the\ntransmission data, or a stored recipient list id attribute can be specified.\n\nThe Recipient List API operates on lists as a whole and does not currently support management of individual recipients.\n\n### Recipient List Object\n\n<DataStructure id=\"161717fe885ddccd17b1d650a061bc7e\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%22results%22%3A%20%7B%0A%20%20%20%20%22id%22%3A%20%22unique_id_4_graduate_students_list%22%2C%0A%20%20%20%20%22name%22%3A%20%22graduate_students%22%2C%0A%20%20%20%20%22description%22%3A%20%22An%20email%20list%20of%20graduate%20students%20at%20UMBC%22%2C%0A%20%20%20%20%22attributes%22%3A%20%7B%0A%20%20%20%20%20%20%22internal_id%22%3A%20112%2C%0A%20%20%20%20%20%20%22list_group_id%22%3A%2012321%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22total_accepted_recipients%22%3A%203%2C%0A%20%20%20%20%22recipients%22%3A%20%5B%20...%20%5D%0A%20%20%7D%0A%7D\"></DataStructure>\n\n### Recipient Object\n\nRecipients are described in an array of objects with the following attributes:\n\n<DataStructure id=\"3587b956bb5f659d62d74e540269e1a5\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22address%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22email%22%3A%20%22fred.jones@flintstone.com%22%2C%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22Grad%20Student%20Office%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22tags%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%22driver%22%2C%0A%20%20%20%20%20%20%20%20%22fred%22%2C%0A%20%20%20%20%20%20%20%20%22flintstone%22%0A%20%20%20%20%5D%2C%0A%20%20%20%20%22metadata%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22age%22%3A%20%2233%22%2C%0A%20%20%20%20%20%20%20%20%22place%22%3A%20%22NY%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22substitution_data%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22favorite_color%22%3A%20%22Bright%20Green%22%2C%0A%20%20%20%20%20%20%20%20%22job%22%3A%20%22Firefighter%22%0A%20%20%20%20%7D%0A%7D\"></DataStructure>\n\n### Address Object\n\nIf the `address` attribute is a string, it is interpreted as the email address. If it is an object, it is described with the following attributes:\n\n<DataStructure id=\"156632d2e5c7f656c659c1ff774b5b1b\"  title=\"Attributes\" ></DataStructure>\n\n**Constructing Headers using the Address Attributes**\n\nThe _address.email_ attribute is used as the envelope RCPT TO value.\n\nIf the address attribute is specified as a string instead of an address object, the address string is used as the envelope RCPT TO value.\n\nThe _address.name_ attribute, in conjuction with the _address.email_ attribute, is used to construct the\ncontent `To` header.\n\n`To: \"address.name\" <address.email>`\n\nIf the _address.name_ attribute is not specified, the `To` header uses the _address.email_ attribute in contructing the header.\n\n`To: address.email`\n\nIf the address is specified as a string instead of an address object, the `To` header is constructed using the address string.\n\n`To: address`\n\nIf the _address.header_to_ attribute is specified, then the `To` header uses\nthe _address.header_to_ attribute in constructing the header.\n_address.header_to_ can be used to BCC (blind carbon copy) recipients,\nby hiding the envelope RCPT TO address and replacing it\nwith an alternative address in the `To` header.\n\n`To: address.header_to`\n\nor:\n\n`To: \"address.name\" <address.header_to>`\n\nThe `To` header is only constructed for messages built from email part content.  The `To` header is not built for email_rfc822 content."},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists{?num_rcpt_errors}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists{?num_rcpt_errors}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of recipient errors that this call can return, otherwise all validation errors are returned."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"num_rcpt_errors"},"value":{"element":"string","content":"3"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"57996b30dbc8ec180f1192a71e942b2d\"  ></DataStructure>\n\nAt a minimum, the `recipients` array is required, which must contain a valid [address](#header-address-object). Use the `num_rcpt_errors` parameter to limit the number of recipient errors\nreturned."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"id\": \"unique_id_4_graduate_students_list\",\n      \"name\": \"graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"fred.jones@flintstone.com\",\n                  \"name\": \"Grad Student Office\",\n                  \"header_to\": \"grad-student-office@flintstone.com\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"33\",\n                  \"place\": \"NY\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Bright Green\",\n                  \"job\": \"Firefighter\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 0,\n          \"total_accepted_recipients\": 3,\n          \"id\": \"unique_id_4_graduate_students_list\",\n          \"name\": \"graduate_students\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"id\": \"unique_id_4_graduate_students_list\",\n      \"name\": \"graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"fred.jones@flintstone.com\",\n                  \"name\": \"Grad Student Office\",\n                  \"header_to\": \"grad-student-office@flintstone.com\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"33\",\n                  \"place\": \"NY\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Bright Green\",\n                  \"job\": \"Firefighter\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"At least one valid recipient is required\",\n              \"code\": \"5002\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"id\": \"unique_id_4_graduate_students_list\",\n      \"name\": \"graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"fred.jones@flintstone.com\",\n                  \"name\": \"Grad Student Office\",\n                  \"header_to\": \"grad-student-office@flintstone.com\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"33\",\n                  \"place\": \"NY\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Bright Green\",\n                  \"job\": \"Firefighter\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"    {\n        \"errors\": [\n            {\n                \"message\": \"List already exists\",\n                \"code\": \"5001\",\n                \"description\": \"List 'unique_id_4_graduate_students_list' already exists\"\n            }\n        ]\n    }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"id\": \"unique_id_4_graduate_students_list\",\n      \"name\": \"graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"fred.jones@flintstone.com\",\n                  \"name\": \"Grad Student Office\",\n                  \"header_to\": \"grad-student-office@flintstone.com\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"33\",\n                  \"place\": \"NY\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Bright Green\",\n                  \"job\": \"Firefighter\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"    {\n        \"errors\": [\n            {\n                \"message\": \"invalid data format/type\",\n                \"code\": \"1300\",\n                \"description\": \"List id 'rcptlist_id_students_list' cannot start with 'rcptlist_'\"\n            }\n        ]\n    }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}{?show_recipients}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}{?show_recipients}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"unique_id_4_graduate_students"}}},{"element":"member","meta":{"description":{"element":"string","content":"If true, return all the recipients contained in the list."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"show_recipients"},"value":{"element":"string","content":"true"}}}]}},"content":[{"element":"copy","content":"Retrieve details about a specified recipient list by specifying its id in the URI path.  To\nretrieve the recipients contained in a list, the list must be specified and the `show_recipients` parameter must be set to true."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"id\": \"unique_id_4_graduate_students_list\",\n          \"name\": \"graduate_students\",\n          \"description\": \"An email list of graduate students at UMBC\",\n          \"attributes\": {\n              \"internal_id\": 112,\n              \"list_group_id\": 12321\n          },\n          \"total_accepted_recipients\": 3,\n          \"recipients\": [\n              {\n                  \"address\": {\n                      \"email\": \"wilmaflin@yahoo.com\",\n                      \"name\": \"Wilma\"\n                  },\n                  \"tags\": [\n                      \"greeting\",\n                      \"prehistoric\",\n                      \"fred\",\n                      \"flintstone\"\n                  ],\n                  \"metadata\": {\n                      \"age\": \"24\",\n                      \"place\": \"Bedrock\"\n                  },\n                  \"substitution_data\": {\n                      \"favorite_color\": \"SparkPost Orange\",\n                      \"job\": \"Software Engineer\"\n                  }\n              },\n              {\n                  \"address\": {\n                      \"email\": \"abc@flintstone.com\",\n                      \"name\": \"ABC\"\n                  },\n                  \"tags\": [\n                      \"driver\",\n                      \"flintstone\"\n                  ],\n                  \"metadata\": {\n                      \"age\": \"52\",\n                      \"place\": \"MD\"\n                  },\n                  \"substitution_data\": {\n                      \"favorite_color\": \"Sky Blue\",\n                      \"job\": \"Driver\"\n                  }\n              },\n              {\n                  \"address\": {\n                      \"email\": \"fred.jones@flintstone.com\",\n                      \"name\": \"Grad Student Office\",\n                      \"header_to\": \"grad-student-office@flintstone.com\"\n                  },\n                  \"tags\": [\n                      \"driver\",\n                      \"fred\",\n                      \"flintstone\"\n                  ],\n                  \"metadata\": {\n                      \"age\": \"33\",\n                      \"place\": \"NY\"\n                  },\n                  \"substitution_data\": {\n                      \"favorite_color\": \"Bright Green\",\n                      \"job\": \"Firefighter\"\n                  }\n              }\n          ]\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"code\": \"1600\",\n              \"description\": \"List 'unique_id_4_graduate_students_list' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}{?num_rcpt_errors}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}{?num_rcpt_errors}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"unique_id_4_graduate_students_list"}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of recipient errors that this call can return, otherwise all validation errors are returned."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"num_rcpt_errors"},"value":{"element":"string","content":"3"}}}]}},"content":[{"element":"copy","content":"If a `recipients` array is provided in the update request, it will replace the current recipients. This means that if you're adding, updating, or removing a single recipient, the `recipients` array must contain all current recipients, regardless they are being changed or not.\n\n<DataStructure id=\"b63a8acbaba94adce148151c49d13c10\"  ></DataStructure>\n\n#### Limitations\n\nIf a transmission using the recipient list has a `state` of \"submitted\" or \"generating\", the list cannot be updated. Also, if the transmission is scheduled and is within 10 minutes of the scheduled time, the list won't be updatable.\n\n#### Returns\n\nReturns the recipient list's `name` and `id`. If the `recipients` array was updated, it includes the number of accepted and rejected recipients."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 0,\n          \"total_accepted_recipients\": 2,\n          \"id\": \"unique_id_4_graduate_students_list\",\n          \"name\": \"updated_graduate_students\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"invalid uri\",\n              \"code\": \"1101\",\n              \"description\": \"PUT requires a recipient list id in the URI\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"At least one valid recipient is required\",\n              \"code\": \"5002\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"code\": \"1600\",\n              \"description\": \"List 'unique_id_4_graduate_students_list' does not exist\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource conflict\",\n              \"code\": \"1602\",\n              \"description\": \"List 'unique_id_4_graduate_students_list' is in use by msg generation\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource conflict\",\n              \"code\": \"1602\",\n              \"description\": \"List 'unique_id_4_graduate_students_list' is in use by another request\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"name\": \"updated_graduate_students\",\n      \"description\": \"An email list of graduate students at UMBC\",\n      \"attributes\": {\n          \"internal_id\": 112,\n          \"list_group_id\": 12321\n      },\n        \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilmaflin@yahoo.com\",\n                  \"name\": \"Wilma\"\n              },\n              \"tags\": [\n                  \"greeting\",\n                  \"prehistoric\",\n                  \"fred\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"24\",\n                  \"place\": \"Bedrock\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"SparkPost Orange\",\n                  \"job\": \"Software Engineer\"\n              }\n          },\n          {\n              \"address\": {\n                  \"email\": \"abc@flintstone.com\",\n                  \"name\": \"ABC\"\n              },\n              \"tags\": [\n                  \"driver\",\n                  \"flintstone\"\n              ],\n              \"metadata\": {\n                  \"age\": \"52\",\n                  \"place\": \"MD\"\n              },\n              \"substitution_data\": {\n                  \"favorite_color\": \"Sky Blue\",\n                  \"job\": \"Driver\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"invalid data format/type\",\n              \"code\": \"1300\",\n              \"description\": \"List id 'unique_id_4_graduate_students_list' does not match the list being updated\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Recipient List"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"unique_id_4_graduate_students_list"}}}]}},"content":[{"element":"copy","content":"<Banner status=\"warning\">If a transmission contains a recipient list, the recipient list cannot be deleted if the transmission is submitted or generating.</Banner>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {}\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"invalid uri\",\n              \"code\": \"1101\",\n              \"description\": \"DELETE requires a recipient list id in the URI\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource conflict\",\n              \"code\": \"1602\",\n              \"description\": \"List 'unique_id_4_graduate_students_list' is in use by msg generation\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List all Recipient Lists"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List all Recipient Lists"}},"attributes":{"href":{"element":"string","content":"/v1/recipient-lists"}},"content":[{"element":"copy","content":"Returns an array of abbreviated recipient list objects. The recipients for each list are not included in the results. [Retrieve a single list](#recipient-lists-get-retrieve-a-recipient-list) to get a list the recipients."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": [\n          {\n              \"id\": \"unique_id_4_graduate_students_list\",\n              \"name\": \"graduate_students\",\n              \"description\": \"An email list of graduate students at UMBC\",\n              \"attributes\": {\n                  \"internal_id\": 112,\n                  \"list_group_id\": 12321\n              },\n              \"total_accepted_recipients\": 3\n          },\n          {\n              \"id\": \"unique_id_4_undergraduates\",\n              \"name\": \"undergraduate_students\",\n              \"description\": \"An email list of undergraduate students at UMBC\",\n              \"attributes\": {\n                  \"internal_id\": 111,\n                  \"list_group_id\": 11321\n              },\n              \"total_accepted_recipients\": 8\n          }\n      ]\n  }\n"}]}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"161717fe885ddccd17b1d650a061bc7e"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique alphanumeric ID. <br /> Maximum length: 64 bytes"}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Recipient list display name. <br />  Maximum length: 64 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the recipient list. <br /> Maximum length: 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"An object of arbitrary metadata related to this list. This data is not used by the API. It is only for the user."}},"content":{"key":{"element":"string","content":"attributes"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of recipient objects. See the [Recipient Object](#header-recipient-object)."}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"array","content":[{"element":"object"}]}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"3587b956bb5f659d62d74e540269e1a5"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Address information for a recipient. See the [Address Object](#header-address-object)."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"address"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"object"},{"element":"string"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"  Email address to use for envelope FROM. Overrides transmission level return_path. The domain part of the return_path address must be a [CNAME-verified sending domain](/api/sending-domains/#sending-domains-post-verify-a-sending-domain). The local part of the return_path address will be overwritten by SparkPost.<br><br>For <a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a> accounts, the return_path may be any valid email address and the localpart in the return_path will **not** be overwritten by SparkPost."}},"content":{"key":{"element":"string","content":"return_path"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of text labels associated with a recipient. Tags are available in Webhook events.  Maximum number of tags - 10 per recipient, 100 system wide.  Any tags over the limits are ignored."}},"content":{"key":{"element":"string","content":"tags"},"value":{"element":"array"}}},{"element":"member","meta":{"description":{"element":"string","content":"Key/value pairs associated with a recipient. Metadata is available during events through the Webhooks and is provided to the template engine. Recipient metadata takes precedence over transmission metadata when there are conflicts. The maximum length is 10KB per recipient."}},"content":{"key":{"element":"string","content":"metadata"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Key/value pairs associated with a recipient that are provided to the template engine. Recipient substitution data takes precedence over transmission substitution data. Unlike metadata, substitution data is not included in Webhook events. The maximum length is 100KB per recipient."}},"content":{"key":{"element":"string","content":"substitution_data"},"value":{"element":"object"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"156632d2e5c7f656c659c1ff774b5b1b"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Valid email address"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"email"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Name attached to the email address"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Email address to display in the `To` header instead of _address.email_ ([for CC and BCC](https://support.sparkpost.com/customer/en/portal/articles/2432290-using-cc-and-bcc-with-the-rest-api)) "}},"content":{"key":{"element":"string","content":"header_to"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"57996b30dbc8ec180f1192a71e942b2d"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique alphanumeric ID. If an id is not specified, one is generated. <br /> Maximum length: 64 bytes"}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Recipient list display name. If a name is not specified, it defaults to the same value as id. <br />  Maximum length: 64 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the recipient list. <br /> Maximum length: 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"An object of arbitrary metadata related to this list."}},"content":{"key":{"element":"string","content":"attributes"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of recipient objects. See the [Recipient Object](#header-recipient-object)."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"array","content":[{"element":"object"}]}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"b63a8acbaba94adce148151c49d13c10"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Recipient list display name. <br />  Maximum length: 64 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the recipient list. <br /> Maximum length: 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"An object of arbitrary metadata related to this list. Specifying this will completely replace the current value."}},"content":{"key":{"element":"string","content":"attributes"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of recipient objects. The new recipients will completely replace the existing recipients. See the [Recipient Object](#header-recipient-object)."}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"array","content":[{"element":"object"}]}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7670},{"element":"number","content":390}]}]}]}},"content":"response payload `400` already defined for `POST` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":16168},{"element":"number","content":296}]}]}]}},"content":"response payload `400` already defined for `PUT` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":17218},{"element":"number","content":384}]}]}]}},"content":"response payload `409` already defined for `PUT` method"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":18935},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":18947},{"element":"number","content":18}]},{"element":"array","content":[{"element":"number","content":18973},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":18993},{"element":"number","content":46}]},{"element":"array","content":[{"element":"number","content":19047},{"element":"number","content":30}]},{"element":"array","content":[{"element":"number","content":19085},{"element":"number","content":101}]},{"element":"array","content":[{"element":"number","content":19194},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":19214},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":19230},{"element":"number","content":4}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":20775},{"element":"number","content":88}]}]}]}},"content":"ignoring unrecognized type attribute"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":23328},{"element":"number","content":133}]}]}]}},"content":"ignoring unrecognized type attribute"}]},"TableOfContents":[{"anchor":"#recipient-lists","title":"Recipient Lists","children":[{"anchor":"#header-recipient-list-object","title":"Recipient List Object"},{"anchor":"#header-recipient-object","title":"Recipient Object"},{"anchor":"#header-address-object","title":"Address Object"},{"anchor":"#recipient-lists-create-a-recipient-list","title":"Create a Recipient List","children":[{"anchor":"#recipient-lists-post-create-a-recipient-list","title":"Create a Recipient List"}]},{"anchor":"#recipient-lists-retrieve-a-recipient-list","title":"Retrieve a Recipient List","children":[{"anchor":"#recipient-lists-get-retrieve-a-recipient-list","title":"Retrieve a Recipient List"}]},{"anchor":"#recipient-lists-update-a-recipient-list","title":"Update a Recipient List","children":[{"anchor":"#recipient-lists-put-update-a-recipient-list","title":"Update a Recipient List","children":[{"anchor":"#header-limitations","title":"Limitations"},{"anchor":"#header-returns","title":"Returns"}]}]},{"anchor":"#recipient-lists-delete-a-recipient-list","title":"Delete a Recipient List","children":[{"anchor":"#recipient-lists-delete-delete-a-recipient-list","title":"Delete a Recipient List"}]},{"anchor":"#recipient-lists-list-all-recipient-lists","title":"List all Recipient Lists","children":[{"anchor":"#recipient-lists-get-list-all-recipient-lists","title":"List all Recipient Lists"}]}]}],"meta":{"title":"Recipient Lists API","description":"Manage recipient lists, collections of recipients that can be used when sending messages.","full":false},"fields":{"path":"/api/recipient-lists/"}}},"pageContext":{"file":"recipient-lists.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}