ListSubscriber

An object that contains information about 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
ClientClientID objectSpecifies the account ownership and context of an object.
CorrelationIDStringIdentifies correlation of objects across several requests.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
ListIDIntDefines identification for a list the subscriber resides on.
ModifiedDateDateTimeThe date and time when the object was last modified.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OwnerOwner objectDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
StatusSubscriberStatus objectDefines status of a subscriber's address. Valid values include:
  • Active
  • Bounced
  • Held
  • Unsubscribed
  • Deleted
SubscriberKeyStringIdentification of a specific subscriber.