An object that represents a link in a message. This object has no supported methods, but you can return some properties using the LinkSend object and retrieve method.
Properties
| Name | Data Type | Description |
|---|---|---|
Alias |
String | Name of link contained in message. |
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. |
LastClicked |
DateTime | Indicates last time a link included in a message was clicked. |
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. |
Subscribers |
Array of TrackingEvent objects | Indicates subscribers associated with an object. |
TotalClicks |
Int | Indicates total number of clicks on link in message. |
UniqueClicks |
Int | Indicates number of unique clicks on message. |
URL |
String | Indicates URL included in an event or configuration. |