{"componentChunkName":"component---src-templates-api-js","path":"/api/suppression-list/","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":"Suppression List API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage your suppression list - a list of recipient email addresses to which you do NOT want to send email."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Suppression List"}},"content":[{"element":"copy","content":"A suppression list, also known as an exclusion list, stores a recipient's opt-out preferences.\nIt is a list of recipient email addresses to which you do NOT want to send email.\nEach entry indicates whether the recipient opted out of receiving one of the following:\n\n-   Transactional messages - single recipient messages that are used operationally, e.g. to reset a password or confirm a purchase.\n\n-   Non-transactional messages - used to run email campaigns where a list of recipients are targeted, e.g. advertising a sales event.\n\nSuppressions can be either **account-wide** (blocking all emails of a given type) or **list-specific** (blocking emails only from a particular mailing list). Use the optional `list_id` field to create list-specific suppressions for more granular control.\n\n<Banner status=\"success\">When setting up your SparkPost account, we <strong>strongly recommend</strong> you import any suppression list you have from any previous service to avoid incorrectly sending mail to unsubscribed/invalid recipients.</Banner>\n\n## Recipient Maintenance\n\nIt's good practice to maintain your recipient lists by removing recipients based on the bounce, unsubscribe, and spam complaint events provided by SparkPost.\nThese events are available from [webhooks](/api/webhooks/) and [message events](/api/message-events/).\n\nSparkPost supports bulk importing or manually adding up to 1,000,000 suppression list entries total.\n\n## Subaccount Suppressions\n\nEach subaccount has it's own independent suppression list.\nSet the `X-MSYS-SUBACCOUNT` header to a subaccount ID to search and operate on that subaccount's suppression list.\nBy default, the search endpoint will search across the primary account's and all subaccounts' lists.\n\n## Suppression Object\n\n<DataStructure id=\"5329833ad26fe396d38ae4be1c7e7e01\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22recipient%22%3A%20%22recip@example.com%22%2C%0A%20%20%20%20%22type%22%3A%20%22non_transactional%22%2C%0A%20%20%20%20%22source%22%3A%20%22List%20Unsubscribe%22%2C%0A%20%20%20%20%22description%22%3A%20%22Unsubscribed%20using%20list%20unsubscribe%20header%22%2C%0A%20%20%20%20%22list_id%22%3A%20%22newsletter-weekly.example1.com%22%2C%0A%20%20%20%20%22created%22%3A%20%222017-10-01T12%3A00%3A00+00%3A00%22%2C%0A%20%20%20%20%22updated%22%3A%20%222017-10-01T12%3A00%3A00+00%3A00%22%2C%0A%20%20%20%20%22transactional%22%3A%20false%2C%0A%20%20%20%20%22non_transactional%22%3A%20true%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Bulk Create or Update Suppressions"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Bulk Create or Update Suppressions"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/"}},"content":[{"element":"copy","content":"Bulk create or update entries in the suppression list.\n\nIf a recipient was added by our compliance system, it cannot be updated.\n\n<DataStructure id=\"c3d976b1310dda8b36f2838d96d84ac1\"  ></DataStructure>\n\n<DataStructure id=\"283d0127b360d72660cff8c946768ad3\"  title=\"Recipient Object\" ></DataStructure>\n\nPlease note that in the unlikely scenario where your receive a HTTP 5xx level error response while bulk loading, only some of your suppression entries may have been successfully created or updated.\nIf this occurs, please re-submit your original request again for processing."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"recipients\": [\n          {\n              \"recipient\": \"rcpt_1@example.com\",\n              \"type\": \"transactional\",\n              \"description\": \"User requested to not receive any transactional emails.\"\n          },\n          {\n              \"recipient\": \"rcpt_2@example.com\",\n              \"type\": \"non_transactional\",\n              \"description\": \"User requested to not receive any non-transactional emails from newsletter-weekly.example1.com mailing list.\",\n              \"list_id\": \"newsletter-weekly.example1.com\"\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          \"message\": \"Suppression List successfully updated\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"recipients\": [\n          {\n              \"recipient\": \"rcpt_1@example.com\",\n              \"type\": \"transactional\",\n              \"description\": \"User requested to not receive any transactional emails.\"\n          },\n          {\n              \"recipient\": \"rcpt_2@example.com\",\n              \"type\": \"non_transactional\",\n              \"description\": \"User requested to not receive any non-transactional emails from newsletter-weekly.example1.com mailing list.\",\n              \"list_id\": \"newsletter-weekly.example1.com\"\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\": \"PUT body contains 2 invalid or malformed recipient(s): rcpt_1@example.com, rcpt_2@example.com\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Create or Update a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create or Update a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Recipient email address."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipient"},"value":{"element":"string","content":"rcpt@example.com"}}}]}},"content":[{"element":"copy","content":"If the recipient was added by our compliance system, it cannot be updated.\n\n<DataStructure id=\"46c3d44c82a40d22619fa815d4a1e7a5\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\",\n      \"description\": \"Unsubscribe from newsletter\",\n      \"list_id\": \"newsletter-weekly.example1.com\"\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          \"message\": \"Suppression list successfully updated\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\",\n      \"description\": \"Unsubscribe from newsletter\",\n      \"list_id\": \"newsletter-weekly.example1.com\"\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\": \"Must supply a suppression type\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\",\n      \"description\": \"Unsubscribe from newsletter\",\n      \"list_id\": \"newsletter-weekly.example1.com\"\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\": \"Type must be one of: \\'transactional\\', \\'non_transactional\\'\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Recipient email address."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipient"},"value":{"element":"string","content":"rcpt@example.com"}}},{"element":"member","meta":{"description":{"element":"string","content":"Types of suppressions to match in the search, i.e. entries that are `transactional` or `non_transactional`."},"title":{"element":"string","content":"list"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"types"},"value":{"element":"string","content":"transactional"}}},{"element":"member","meta":{"description":{"element":"string","content":"The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of results to return per page. Must be between 1 and 10,000."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1000"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"page"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Return all suppression entries for a recipient. If the recipient is not in the suppression list, an HTTP status of 404 is returned.\n\n##### Searching with Subaccounts\n\nIf your account has subaccounts, please provide the `X-MSYS-SUBACCOUNT` header when performing a lookup on a specific suppression list.\n\n-   Use a value of 0 to only search against the primary account suppression list.\n\n-   Use the subaccount's ID to perform a lookup on a specific subaccount suppression list.\n\nIf the `X-MSYS-SUBACCOUNT` header is not provided, a search will be performed across the primary account and all subaccount suppression lists.\nSearches across multiple lists can return out of date results, with a delay of up to 20 minutes.\nSearches against a specific list are not affected by this delay and return up-to-date information.\nIf you don't have subaccounts, you do not need to provide the `X-MSYS-SUBACCOUNT` header in order to receive up-to-date results."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"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              \"recipient\": \"rcpt@example.com\",\n              \"non_transactional\": true,\n              \"type\": \"non_transactional\",\n              \"source\": \"Manually Added\",\n              \"description\": \"User requested to not receive any non-transactional emails.\",\n              \"list_id\": \"newsletter-weekly.example1.com\",\n              \"created\": \"2015-01-01T12:00:00+00:00\",\n              \"updated\": \"2015-01-01T12:00:00+00:00\"\n          },\n          {\n              \"recipient\": \"rcpt@example.com\",\n              \"non_transactional\": true,\n              \"type\": \"non_transactional\",\n              \"source\": \"Bounce Rule\",\n              \"description\": \"550: 550 - Domain has been disabled. #7\",\n              \"created\": \"2016-10-01T12:00:00+00:00\",\n              \"updated\": \"2016-10-01T12:00:00+00:00\",\n              \"subaccount_id\": \"146\"\n          }\n      ],\n      \"links\": [],\n      \"total_count\": 2\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Suppression"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/{recipient}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Recipient email address."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipient"},"value":{"element":"string","content":"rcpt@example.com"}}},{"element":"member","meta":{"description":{"element":"string","content":"Mailing list identifier. If provided, deletes the suppression only for that specific mailing list. If omitted, deletes the suppression across all mailing lists."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string","content":"newsletter-weekly.example1.com"}}}]}},"content":[{"element":"copy","content":"##### Deleting from subaccounts\n\nIf your account has subaccounts, please provide the `X-MSYS-SUBACCOUNT` header when deleting from a specific subaccount suppression list.\n\n-   Omit the header to delete from the primary account suppression list.\n\n-   Use the subaccount's ID to delete from a specific subaccount suppression list.\n\n##### Deleting from mailing lists\n\nUse the `list_id` query parameter to control which suppression entries are deleted:\n\n-   Use `?list_id=newsletter-weekly.example1.com` to delete the suppression from a specific mailing list.\n\n-   Use `?list_id=` (empty value) to delete only the account-level suppression entry (not bound to any mailing list).\n\n-   Omit the parameter to delete **all** suppression entries for the recipient (account-level and all list-specific).\n\n<DataStructure id=\"29f281b8af0a661cb81397e4a411a1bf\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}}}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"403"},"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\": \"Recipient could not be removed - Compliance\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"type\": \"transactional\"\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\": \"Recipient could not be found\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Search Suppressions"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list{?to,from,domain,sources,types,description,description_strict,list_id,cursor,per_page,page,sort}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Search Suppressions"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list{?to,from,domain,sources,types,description,description_strict,list_id,cursor,per_page,page,sort}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Date the suppressions were last updated, in the format of `YYYY-MM-DDTHH:mm:ssZ`."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"to"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"now"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Date the suppressions were last updated, in the format `YYYY-MM-DDTHH:mm:ssZ`."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"string","content":"2017-01-01T09:00:00-0400"}}},{"element":"member","meta":{"description":{"element":"string","content":"Domains to match in the search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}},{"element":"member","meta":{"description":{"element":"string","content":"Sources to match in the search, i.e. entries that were added by this source."},"title":{"element":"string","content":"list"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"sources"},"value":{"element":"string","content":"Bounce%20Rule,Manually%20Added"}}},{"element":"member","meta":{"description":{"element":"string","content":"Types of suppressions to match in the search, i.e. entries that are `transactional` or `non_transactional`."},"title":{"element":"string","content":"list"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"types"},"value":{"element":"string","content":"transactional"}}},{"element":"member","meta":{"description":{"element":"string","content":"String to match in suppression descriptions."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"A complementary field to description. When set to true, will match the exact content in the search description, alternatively will fetch all combination of results in the description."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"description_strict"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"false"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Filter by mailing list identifier to return only list-specific suppressions."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of results to return per page. Must be between 1 and 10,000."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1000"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"page"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Sort will return results sorted by the `updated` field in ascending (`asc`) or descending (`desc`) order."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"sort"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"desc"}},"enumerations":{"element":"array","content":[{"element":"string","content":"asc"},{"element":"string","content":"desc"}]}}}}}]}},"content":[{"element":"copy","content":"Perform a filtered search for entries in your suppression list. Returns an array of suppression objects."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"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              \"recipient\": \"test@example.com\",\n              \"source\": \"Bounce Rule\",\n              \"type\": \"transactional\",\n              \"created\": \"2017-02-01T01:01:01+00:00\",\n              \"updated\": \"2017-02-01T01:01:01+00:00\",\n              \"transactional\": true\n          },\n          {\n              \"recipient\": \"test2@example.com\",\n              \"description\": \"550: this email address does not exist #55\",\n              \"source\": \"Manually Added\",\n              \"type\": \"transactional\",\n              \"created\": \"2018-01-01T01:01:01+00:00\",\n              \"updated\": \"2018-01-01T01:01:01+00:00\",\n              \"non_transactional\": true\n          },\n          {\n              \"recipient\": \"test3@example.com\",\n              \"description\": \"Recipient unsubscribed\",\n              \"source\": \"Bounce Rule\",\n              \"type\": \"transactional\",\n              \"list_id\": \"newsletter-weekly.example1.com\",\n              \"created\": \"2018-01-01T01:01:01+00:00\",\n              \"updated\": \"2018-01-01T01:01:01+00:00\",\n              \"transactional\": true\n          }\n      ],\n      \"links\": [],\n      \"total_count\": 3\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve Summary"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/summary"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve Summary"}},"attributes":{"href":{"element":"string","content":"/v1/suppression-list/summary"}},"content":[{"element":"copy","content":"Returns the total number of suppressions for your account, as well as a break down of suppressions by source."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"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          \"compliance\": 1,\n          \"manually_added\": 1542,\n          \"unsubscribe_link\": 1,\n          \"bounce_rule\": 3891,\n          \"list_unsubscribe\": 1,\n          \"spam_complaint\": 1,\n          \"total\": 5437\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":"5329833ad26fe396d38ae4be1c7e7e01"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Email address to be suppressed."}},"content":{"key":{"element":"string","content":"recipient"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Type of suppression record."}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"transactional"},{"element":"string","content":"non_transactional"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Source responsible for creating the list entry."}},"content":{"key":{"element":"string","content":"source"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"Spam Complaint"},{"element":"string","content":"List Unsubscribe"},{"element":"string","content":"Bounce Rule"},{"element":"string","content":"Unsubscribe Link"},{"element":"string","content":"Manually Added"},{"element":"string","content":"Compliance"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Explanation for the suppression."}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Mailing list identifier for list-specific suppressions. Only returned if suppressed for a specific list. Must be RFC 2919 compliant"}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Date suppression was created."}},"content":{"key":{"element":"string","content":"created"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Last time the suppression was updated."}},"content":{"key":{"element":"string","content":"updated"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the recipient requested to not receive any transactional messages. <span class=\"label label-danger\"><strong>Deprecated</strong></span> in favor of `type`."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the recipient requested to not receive any non-transactional messages. <span class=\"label label-danger\"><strong>Deprecated</strong></span> in favor of `type`."}},"content":{"key":{"element":"string","content":"non_transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Which subaccount the recipient is suppressed for. Only returned if suppressed for a specific subaccount."}},"content":{"key":{"element":"string","content":"subaccount_id"},"value":{"element":"number"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"c3d976b1310dda8b36f2838d96d84ac1"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Array of recipient objects to add to or updates in the suppression list. Max size: 50mb. Max length: 10,000."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"array"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"283d0127b360d72660cff8c946768ad3"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Email address to be suppressed."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipient"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Type of suppression record."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"transactional"},{"element":"string","content":"non_transactional"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Explanation for the suppression."}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Mailing list identifier for list-specific suppressions. Must be RFC 2919 compliant. Omit for account-wide suppression."}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"46c3d44c82a40d22619fa815d4a1e7a5"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Type of suppression record."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"transactional"},{"element":"string","content":"non_transactional"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Explanation for the suppression."}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Mailing list identifier for list-specific suppressions. Must be RFC 2919 compliant. Omit for account-wide suppression."}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"29f281b8af0a661cb81397e4a411a1bf"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"The type of suppression to delete. If not provided, the suppression will be deleted for both transactional and non-transactional."}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"transactional"},{"element":"string","content":"non_transactional"}]}}}}}]}}]}]},{"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":3326},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":3338},{"element":"number","content":22}]},{"element":"array","content":[{"element":"number","content":3368},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":3388},{"element":"number","content":49}]},{"element":"array","content":[{"element":"number","content":3445},{"element":"number","content":39}]},{"element":"array","content":[{"element":"number","content":3492},{"element":"number","content":87}]},{"element":"array","content":[{"element":"number","content":3587},{"element":"number","content":13}]},{"element":"array","content":[{"element":"number","content":3608},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":3628},{"element":"number","content":49}]},{"element":"array","content":[{"element":"number","content":3685},{"element":"number","content":43}]},{"element":"array","content":[{"element":"number","content":3736},{"element":"number","content":141}]},{"element":"array","content":[{"element":"number","content":3885},{"element":"number","content":58}]},{"element":"array","content":[{"element":"number","content":3951},{"element":"number","content":12}]},{"element":"array","content":[{"element":"number","content":3971},{"element":"number","content":8}]},{"element":"array","content":[{"element":"number","content":3987},{"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":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7381},{"element":"number","content":14}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5578},{"element":"number","content":67}]}]}]}},"content":"parameter 'types' is not found within the URI template '/v1/suppression-list/{recipient}' for 'Retrieve a Suppression' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5578},{"element":"number","content":67}]}]}]}},"content":"parameter 'cursor' is not found within the URI template '/v1/suppression-list/{recipient}' for 'Retrieve a Suppression' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5578},{"element":"number","content":67}]}]}]}},"content":"parameter 'per_page' is not found within the URI template '/v1/suppression-list/{recipient}' for 'Retrieve a Suppression' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5578},{"element":"number","content":67}]}]}]}},"content":"parameter 'page' is not found within the URI template '/v1/suppression-list/{recipient}' for 'Retrieve a Suppression' "},{"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":5578},{"element":"number","content":67}]}]}]}},"content":"the resource '/v1/suppression-list/{recipient}' is already defined"},{"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":9799},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":9811},{"element":"number","content":30}]},{"element":"array","content":[{"element":"number","content":9849},{"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":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":8498},{"element":"number","content":68}]}]}]}},"content":"parameter 'list_id' is not found within the URI template '/v1/suppression-list/{recipient}' for 'Delete a Suppression' "},{"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":8498},{"element":"number","content":68}]}]}]}},"content":"the resource '/v1/suppression-list/{recipient}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":12449},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":13973},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":15640},{"element":"number","content":143}]}]}]}},"content":"no value(s) specified"}]},"TableOfContents":[{"anchor":"#suppression-list","title":"Suppression List","children":[{"anchor":"#header-recipient-maintenance","title":"Recipient Maintenance"},{"anchor":"#header-subaccount-suppressions","title":"Subaccount Suppressions"},{"anchor":"#header-suppression-object","title":"Suppression Object"},{"anchor":"#suppression-list-bulk-create-or-update-suppressions","title":"Bulk Create or Update Suppressions","children":[{"anchor":"#suppression-list-put-bulk-create-or-update-suppressions","title":"Bulk Create or Update Suppressions"}]},{"anchor":"#suppression-list-create-or-update-a-suppression","title":"Create or Update a Suppression","children":[{"anchor":"#suppression-list-put-create-or-update-a-suppression","title":"Create or Update a Suppression"}]},{"anchor":"#suppression-list-retrieve-a-suppression","title":"Retrieve a Suppression","children":[{"anchor":"#suppression-list-get-retrieve-a-suppression","title":"Retrieve a Suppression","children":[{"anchor":"#header-searching-with-subaccounts","title":"Searching with Subaccounts"}]}]},{"anchor":"#suppression-list-delete-a-suppression","title":"Delete a Suppression","children":[{"anchor":"#suppression-list-delete-delete-a-suppression","title":"Delete a Suppression","children":[{"anchor":"#header-deleting-from-subaccounts","title":"Deleting from subaccounts"},{"anchor":"#header-deleting-from-mailing-lists","title":"Deleting from mailing lists"}]}]},{"anchor":"#suppression-list-search-suppressions","title":"Search Suppressions","children":[{"anchor":"#suppression-list-get-search-suppressions","title":"Search Suppressions"}]},{"anchor":"#suppression-list-retrieve-summary","title":"Retrieve Summary","children":[{"anchor":"#suppression-list-get-retrieve-summary","title":"Retrieve Summary"}]}]}],"meta":{"title":"Suppression List API","description":"Manage your suppression list - a list of recipient email addresses to which you do NOT want to send email.","full":false},"fields":{"path":"/api/suppression-list/"}}},"pageContext":{"file":"suppression-list.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}