Defines a list of subscribers.
Properties
| Name | Data Type | Description |
|---|---|---|
AutomatedEmail |
Email object | Specifies email to send upon a subscriber joining a list. This property corresponds to the Welcome Email functionality. |
Category |
Int | ID of the folder that an item is located in. |
Client |
ClientID object | Specifies the account ownership and context of an object. |
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. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
ListClassification |
ListClassificationEnum | Specifies the classification for a list. Valid values include:<ul><li>ExactTargetList</li><li>PublicationList</li><li>SuppressionList</li></ul> |
ListName |
String | Name of a specific list. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | 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. |
SendClassification |
SendClassification object | Indicates the send classification to use as part of a send definition. |
Subscribers |
Array of Subscriber objects | Indicates subscribers associated with an object. |
Type |
ListTypeEnum | Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. Indicates the type of email to send to the address. Valid values include Text and HTML. |