Subscriber
A person subscribed to receive email or SMS communication. Subscriber represents a single instance of a subscriber.
Properties
| Name | Data Type | Description |
|---|---|---|
| Addresses | SubscriberAddress[] | Indicates addresses belonging to a subscriber. |
| Attributes | Attribute[] | Specifies attributes associated with an object. |
| 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. |
| EmailAddress | xsd | Contains the email address for a subscriber. |
| EmailTypePreference | EmailType | Indicates the email format. |
| GlobalUnsubscribeCategory | GlobalUnsubscribeCategory | Indicates how the application handles a globally unsubscribed subscriber. |
| ID | xsd | Read-only legacy identifier for an object. Not supported on all objects. |
| Lists | SubscriberList[] | Defines lists a subscriber resides on. |
| Locale | Locale | Contains the locale information for an Account. |
| ModifiedDate | Nullable`1 | Last time object information was modified. |
| ObjectID | xsd | System-controlled, read-only text string identifier for object. |
| 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. |
| PartnerType | xsd | Defines partner associated with a subscriber. |
| PrimaryEmailAddress | EmailAddress | Indicates primary email address for a subscriber. |
| PrimarySMSAddress | SMSAddress | Indicates primary SMS address for a subscriber. |
| PrimarySMSPublicationStatus | SubscriberAddressStatus | Indicates the subscriber's modality status. |
| Status | SubscriberStatus | Defines status of object. |
| SubscriberKey | xsd | Identification of a specific subscriber. |
| SubscriberTypeDefinition | SubscriberTypeDefinition | Specifies if a subscriber resides in an integration, such as Salesforce or Microsoft Dynamics CRM. |
| UnsubscribedDate | xsd | Represents date subscriber unsubscribed from a list. |