| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/EmailSuppressionList | Return a list of suppressed emails (hard, soft, complaint). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailSuppressionFilter | query | EmailSuppressionFilter | No | Allowable Values
|
| PageSize | query | int | No | |
| PageNumber | query | int | No | |
| OffSet | query | int | No | |
| OrderBy | query | string | No | |
| OrderByDirection | query | string | No | |
| EmailSearchString | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuppressionList | form | List<EmailSuppression> | No | |
| TotalResultsCount | form | int | No | |
| HardBounceHealthRate | form | double | No | |
| SoftBounceHealthRate | form | double | No | |
| ComplaintHealthRate | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailAddress | form | string | No | |
| SuppressionType | form | SuppressionType | No | |
| IsActive | form | bool | No | |
| BounceCount | form | int | No | |
| SuppressCount | form | int | No | |
| SuppressedDate | form | DateTime | No | |
| LastRemoved | form | DateTime | No | |
| OriginalBounceDate | form | DateTime | No | |
| EstimatedRemovalDate | form | DateTime | No | |
| Status | form | string | No | |
| BounceReason | form | string | No | |
| FeedbackType_Group | form | string | No | |
| FeedbackType_Type | form | string | No | |
| FeedbackType_SubType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/EmailSuppressionList HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"SuppressionList":[{"EmailAddress":"String","SuppressionType":"None","IsActive":false,"BounceCount":0,"SuppressCount":0,"SuppressedDate":"0001-01-01T00:00:00.0000000","LastRemoved":"0001-01-01T00:00:00.0000000","OriginalBounceDate":"0001-01-01T00:00:00.0000000","EstimatedRemovalDate":"0001-01-01T00:00:00.0000000","Status":"String","BounceReason":"String","FeedbackType_Group":"String","FeedbackType_Type":"String","FeedbackType_SubType":"String"}],"TotalResultsCount":0,"HardBounceHealthRate":0,"SoftBounceHealthRate":0,"ComplaintHealthRate":0,"EmailSuppressionFilter":"Hard","PageSize":0,"PageNumber":0,"OffSet":0,"OrderBy":"String","OrderByDirection":"String","EmailSearchString":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T09:06:24.5760020-05:00","Device":"Desktop"}