List
The List object is a list of subscribers. To create or update a List where AutomatedEmail contains a customer key and has an ID greater than 0, you need the Email | Subscribers | List | Manage Welcome Email permission.
| Name | Data Type | Description |
|---|---|---|
| AutomatedEmail | Specifies email to send upon a subscriber joining a list. This property corresponds to the Welcome Email functionality. | |
| Category | xsd | ID of the folder that an item is located in. |
| Client | ClientID | Specifies the account ownership and context of an object. |
| CorrelationID | xsd | Identifies correlation of objects across several requests. |
| CreatedDate | xsd | Read-only date and time of the object's creation. |
| CustomerKey | xsd | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
| Description | xsd | Describes and provides information regarding the object. |
| ID | xsd | 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:
|
| ListName | xsd | Name of a specific list. |
| ModifiedDate | Nullable`1 | Indicates the last time object information was modified. |
| ObjectID | xsd | System-controlled, read-only text string identifier for object. |
| ObjectState | xsd | Reserved for future use. |
| Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
| PartnerKey | xsd | Unique identifier provided by partner for an object. This property is accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
| SendClassification | SendClassification | Indicates the send classification to use as part of a send definition. |
| Subscribers | Subscriber[] | 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. |