ListSubscriber

The ListSubscriber object retrieves subscribers for a list or lists for a subscriber. Calls to this object also retrieve any groups to which a subscriber belongs. Perform a call on the specific ID to determine if that ID refers to a list or group.

NameData TypeDescription
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDxsd:stringIdentifies correlation of objects across several requests.
CreatedDatexsd:dateTimeRead-only date and time of the object's creation.
CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
IDxsd:intRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
ListIDxsd:intDefines identification for a list the subscriber resides on.
ModifiedDateNullable`1Indicates the last time object information was modified.
ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object.
ObjectStatexsd:stringReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsd:stringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
StatusSubscriberStatusDefines status of a subscriber's address. Valid values include:
  • Active
  • Bounced
  • Held
  • Unsubscribed
  • Deleted
SubscriberKeyxsd:stringIdentification of a specific subscriber.