The SuppressionListDefinition object is a suppression list that can be associated with different contexts. Once it has been created, the definition can be associated with a variety of different contexts that are specified in the Contexts property. When an email send is processed, the system finds all of the suppression lists to apply. When two or more suppression lists are applicable to a context, the send applies all applicable lists in an additive manner. If two lists are supplied and one list contains customer1@example.com and the other list contains customer2@example.com, the send excludes both addresses.
Properties
| Name | Data Type | Description |
|---|---|---|
Category |
Long | ID of the folder that an item is located in. |
Client |
ClientID | Specifies the account ownership and context of an object. |
Contexts |
Array of SuppressionListContext objects | The contexts with which a SuppressionListDefinition is associated. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
Description |
String | Describes and provides information regarding the object. |
Fields |
Array of DataExtensionField objects | Specifies fields contained within a data extension. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
Name |
String | Name of the object or property. |
NotifyEmail |
String | Defines email address that receives notification once the application applies the auto-suppression list to all existing triggered send jobs. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
SubscriberCount |
Long | Indicates the number of records on a suppression list. |