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.
Properties
| Name | Data Type | Description |
|---|---|---|
Client |
ClientID object | 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. This property corresponds to the external key assigned to an object. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
ListID |
Int | Defines identification for a list the subscriber resides on. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | 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. |
Status |
SubscriberStatus object | Defines status of a subscriber's address. Valid values include:<ul><li>Active</li><li>Bounced</li><li>Held</li><li>Unsubscribed</li><li>Deleted</li></ul> |
SubscriberKey |
String | Identification of a specific subscriber. |