{"_id":"562bd54052fb180d0034cc0b","project":"55dd9f2e0efd5821000d54d9","parentDoc":null,"editedParams":true,"category":{"_id":"562b9f775a39cd0d009aff22","project":"55dd9f2e0efd5821000d54d9","pages":["562ba0bbed4bea0d00c11de2","562ba2436562140d001501cd","562ba4a6f68a5f0d007b1f3a","562ba73c6562140d001501d1","562ba8e19ebc950d000f750b","562badaded4bea0d00c11de6","562bae17db5fea0d003fa832","562baef76562140d001501d4","562baf3ad56bc30d00f0cb1e","562bbfe59ebc950d000f7521","562bc031ed4bea0d00c11df1","562bc060d56bc30d00f0cb2f","562bc0f1d56bc30d00f0cb30","562bc14a5a39cd0d009aff49","562bc17c5a39cd0d009aff4a","562bc8ca5a39cd0d009aff54","562bc9131b98640d0071451b","562bd54052fb180d0034cc0b","562bda3212c2820d00869ba0","562bdab29ebc950d000f753c","562bdb00ff2da50d002c0aac","562bdb851b98640d00714527","562bde831b98640d0071452c","562bded9ff2da50d002c0aae","562be2159ebc950d000f7542","562be2725a39cd0d009aff78","562be33d9ebc950d000f7543","562d619ae01a430d00c2c82d"],"version":"55dd9f4dab0e4d210045aae9","__v":28,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-24T15:10:47.563Z","from_sync":false,"order":22,"slug":"contacts-1","title":"Contacts"},"editedParams2":true,"user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-24T19:00:16.913Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:v2=\"http://apiconnector.com/v2\" xmlns:apic=\"http://apiconnector.com\">\n   <soapenv:Header/>\n   <soapenv:Body>\n      <v2:CreateAddressBook>\n         <v2:apiAddressBook>\n            <apic:Name>My Address Book</apic:Name>\n            <apic:Visibility>Public</apic:Visibility>\n         </v2:apiAddressBook>\n      </v2:CreateAddressBook>\n   </soapenv:Body>\n</soapenv:Envelope>","language":"xml"}]},"results":{"codes":[{"name":"","code":"<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\n   <s:Body>\n      <CreateAddressBookResponse xmlns=\"http://apiconnector.com/v2\">\n         <CreateAddressBookResult xmlns:a=\"http://apiconnector.com\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">\n            <a:Id>0</a:Id>\n            <a:Name>My Address Book</a:Name>\n            <a:Visibility>Public</a:Visibility>\n            <a:Contacts>0</a:Contacts>\n         </CreateAddressBookResult>\n      </CreateAddressBookResponse>\n   </s:Body>\n</s:Envelope>","language":"xml","status":200}]},"settings":"","auth":"required","params":[{"_id":"55ddbc1e746ace2b00dd6f38","ref":"","in":"body","required":true,"desc":"The name of the address book you're creating. It can't be an existing address book's name, 'Test' or 'All contacts'.","default":"","type":"string","name":"Name"},{"_id":"55ddbc1e746ace2b00dd6f37","ref":"","in":"body","required":false,"desc":"All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to.","default":"","type":"string","name":"Visibility"}],"url":"/v:version/ApiService/CreateAddressBook"},"isReference":false,"order":19,"body":"This method can be used to a retrieve a list of contacts who have been suppressed in your account after a specified date, giving a reason for their suppression.\n\nPlease note that contact data field details are not returned in the results for suppressed contacts.\n\nThe possible suppression reasons can be: \n\n  * 'Unsubscribed' - The contact is unsubscribed from your communications\n  * 'SoftBounced' - The contact’s address is temporarily unavailable, possibly because their mailbox is too full, or their mail server won’t accept a message of the size sent, or their server is having temporary issues accepting any mail\n  * 'HardBounced' - The contact’s address is permanently unreachable, most likely because they, or the server they were hosted on, does not exist\n  * 'IspComplained' - The contact has submitted a spam complaint to us via their internet service provider\n  * 'MailBlocked' - The mail server indicated that it didn’t want to receive the mail. No reason was given \n  * 'DirectComplaint' - The contact has complained directly to either us, a hosting facility or possibly even a blacklist about receiving your communications\n  * 'Suppressed' - The contact that has been actively suppressed by you in your account\n  * 'NotAllowed' - The contact's email address is fully blocked from our system\n  * 'DomainSuppression' - The contact’s email domain is on your domain suppression list\n  * 'NoMxRecord' - The contact’s email domain does not have an MX DNS record. A mail exchange record provides the address of the mail server for that domain.\n\nThe select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.\n\nThe skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.\n\n**SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetSuppressedContacts](doc:getsuppressedcontacts)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"**Input parameters**\\n  * StartDate - *required; dateTime* \\n  * Select - *optional; integer*\\n  * Skip - *optional; integer*\\n                 \\n**Output parameters** \\n  * GetSuppressedContactsResult - *array of ContactSuppression*\\n       * ContactSuppression \\n            * SuppressedContact\\n                 * Id - *integer*\\n                 * Email - *string*\\n                 * OptInType - *string ('Unknown', 'Single', 'Double', 'VerifiedDouble')*\\n                 * EmailType - *string ('PlainText', 'Html')* \\n                 * Status - *string ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')*\\n            * DateRemoved - *dateTime*\\n            * Reason -  *string* ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')\",\n  \"title\": \"Input and output parameters\"\n}\n[/block]\n**Example** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"using (var client = new ApiServiceClient())\\n{\\n\\tclient.ClientCredentials.UserName.UserName = \\\"username\\\";\\n\\tclient.ClientCredentials.UserName.Password = \\\"password\\\";\\n\\n\\tvar startDate = new DateTime(2015, 01, 01, 00, 00, 00, DateTimeKind.Utc);\\n\\tvar select = 1000;\\n\\tvar skip = 0;\\n\\tvar suppressions = client.GetSuppressedContacts(startDate, select, skip);\\n}\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"Gets a list of suppressed contacts after a given date along with the reason for suppression","slug":"getsuppressedcontacts","type":"basic","title":"GetSuppressedContacts"}

GetSuppressedContacts

Gets a list of suppressed contacts after a given date along with the reason for suppression

This method can be used to a retrieve a list of contacts who have been suppressed in your account after a specified date, giving a reason for their suppression. Please note that contact data field details are not returned in the results for suppressed contacts. The possible suppression reasons can be: * 'Unsubscribed' - The contact is unsubscribed from your communications * 'SoftBounced' - The contact’s address is temporarily unavailable, possibly because their mailbox is too full, or their mail server won’t accept a message of the size sent, or their server is having temporary issues accepting any mail * 'HardBounced' - The contact’s address is permanently unreachable, most likely because they, or the server they were hosted on, does not exist * 'IspComplained' - The contact has submitted a spam complaint to us via their internet service provider * 'MailBlocked' - The mail server indicated that it didn’t want to receive the mail. No reason was given * 'DirectComplaint' - The contact has complained directly to either us, a hosting facility or possibly even a blacklist about receiving your communications * 'Suppressed' - The contact that has been actively suppressed by you in your account * 'NotAllowed' - The contact's email address is fully blocked from our system * 'DomainSuppression' - The contact’s email domain is on your domain suppression list * 'NoMxRecord' - The contact’s email domain does not have an MX DNS record. A mail exchange record provides the address of the mail server for that domain. The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request. The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set. **SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetSuppressedContacts](doc:getsuppressedcontacts) [block:callout] { "type": "info", "body": "**Input parameters**\n * StartDate - *required; dateTime* \n * Select - *optional; integer*\n * Skip - *optional; integer*\n \n**Output parameters** \n * GetSuppressedContactsResult - *array of ContactSuppression*\n * ContactSuppression \n * SuppressedContact\n * Id - *integer*\n * Email - *string*\n * OptInType - *string ('Unknown', 'Single', 'Double', 'VerifiedDouble')*\n * EmailType - *string ('PlainText', 'Html')* \n * Status - *string ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')*\n * DateRemoved - *dateTime*\n * Reason - *string* ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')", "title": "Input and output parameters" } [/block] **Example** [block:code] { "codes": [ { "code": "using (var client = new ApiServiceClient())\n{\n\tclient.ClientCredentials.UserName.UserName = \"username\";\n\tclient.ClientCredentials.UserName.Password = \"password\";\n\n\tvar startDate = new DateTime(2015, 01, 01, 00, 00, 00, DateTimeKind.Utc);\n\tvar select = 1000;\n\tvar skip = 0;\n\tvar suppressions = client.GetSuppressedContacts(startDate, select, skip);\n}", "language": "csharp" } ] } [/block]