Subscriber

A person subscribed to receive email or SMS communication. Subscriber represents a single instance of a subscriber.

Properties

Name Data Type Description
Addresses Array of SubscriberAddress objects Indicates addresses belonging to a subscriber.
Attributes Array of Attribute objects Specifies attributes associated with an object.
Client ClientID 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.
EmailAddress String 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 Int Read-only legacy identifier for an object. Not supported on all objects.
Lists Array of SubscriberList objects Defines lists a subscriber resides on.
Locale Locale Contains the locale information for an Account.
ModifiedDate DateTime Last time object information was modified.
ObjectID String System-controlled, read-only text string identifier for object.
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.
PartnerType String 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 String Identification of a specific subscriber.
SubscriberTypeDefinition SubscriberTypeDefinition Specifies if a subscriber resides in an integration, such as Salesforce or Microsoft Dynamics CRM.
UnsubscribedDate DateTime Represents date subscriber unsubscribed from a list.