Campaign
The Campaign
object contains information about campaigns. Use this object to perform discrete tasks as part of an automated process. To start or stop a campaign using the perform method, you need the Campaign | Start
or Campaign | Stop
permission.
Name | Data Type | Description |
---|---|---|
Client | ClientID | Specifies the account ownership and context of an object. |
CorrelationID | xsd:string | Identifies correlation of objects across several requests. |
CreatedDate | xsd:dateTime | Read-only date and time of the object's creation. |
CustomerKey | xsd:string | User-supplied unique identifier for an object within an object type. |
Description | xsd:string | Describes and provides information regarding the object. |
ID | xsd:int | Read-only legacy identifier for an object. Not supported on all objects. |
InteractionObjectID | xsd:string | Returns associated ID for activities within the process of the overall conversation or program. |
Keyword | xsd:string | Reserved for future use. |
ModifiedDate | Nullable`1 | Last time object information was modified. |
Name | xsd:string | Name of the object or property. |
ObjectID | xsd:string | System-controlled, read-only text string identifier for object. |
ObjectState | xsd:string | Reserved for future use. |
Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey | xsd:string | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | APIProperty[] | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |