YM REST Services

EmailSuppressionList

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/EmailSuppressionList	Return a list of suppressed emails (hard, soft, complaint).

**EmailSuppressionList** Parameters:
Name	Parameter	Data Type	Required	Description
EmailSuppressionFilter	query	EmailSuppressionFilter	No	Allowable Values Hard Soft Hard_Soft Complaint Hard_Complaint Soft_Complaint Hard_Soft_Complaint
PageSize	query	int	No
PageNumber	query	int	No
OffSet	query	int	No
OrderBy	query	string	No
OrderByDirection	query	string	No
EmailSearchString	query	string	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**EmailSuppressionListResponse** Parameters:
Name	Parameter	Data Type	Required
SuppressionList	form	List<EmailSuppression>	No
TotalResultsCount	form	int	No
HardBounceHealthRate	form	double	No
SoftBounceHealthRate	form	double	No
ComplaintHealthRate	form	double	No

**EmailSuppression** Parameters:
Name	Parameter	Data Type	Required
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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SuppressionList: 
	[
		{
			EmailAddress: String,
			SuppressionType: None,
			IsActive: False,
			BounceCount: 0,
			SuppressCount: 0,
			SuppressedDate: 0001-01-01,
			LastRemoved: 0001-01-01,
			OriginalBounceDate: 0001-01-01,
			EstimatedRemovalDate: 0001-01-01,
			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-15T08:49:22.6425967-05:00,
	Device: Desktop
}

YM REST Services

EmailSuppressionList

Allowable Values

HTTP + JSV