AutomationInstance

Represents a specific execution of an automation in Automation Studio. Every time an automation runs, whether on a schedule or executed manually, Marketing Cloud Engagement creates an AutomationInstance record to track that execution.

Name Data Type Description
AutomationID String Identifies automation associated with this instance. This field is supported for backward compatibility.
AutomationSource AutomationSource object Identifies source of automation.
AutomationTasks Array of AutomationTasks objects Identifies tasks within automation.
AutomationType String Identifies type of automation.
Client ClientID object Defines which account owns the automation.
CompletedTime DateTime Indicates when automation completed.
CorrelationID String Identifies calls involved in a specific asynchronous process.
CreatedDate DateTime The date and time when the object was created.
CustomerKey String User-supplied unique identifier for an object within an object type.
Description String Describes and provides information regarding the object.
ID Int Read-only legacy identifier for an object. Not supported on all objects.
InteractionObjectID String Returns associated ID for activities within the asynchronous process of the overall conversation or program.
IsActive Boolean Specifies whether the object is active.
Keyword String Reserved for future use.
ModifiedDate DateTime The date and time when the object was last modified.
Name String Name of the object or property.
Notifications Array of AutomationNotification objects Indicates notifications to use when automation completes.
ObjectID String System-controlled, read-only text string identifier for object.
ObjectState String Reserved for future use.
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 client and stored by system. This property is accessible only via API.
Schedule ScheduleDefinition object Indicates schedule for automation.
ScheduledTime DateTime Keeps requests in asynchronous queue until time specified in call.
StartTime DateTime The date and time that this instance of an automation started.
Status Int Indicates status of automation.
StatusLastUpdate DateTime The date and time that the status of this instance of the activity was last updated.
StatusMessage String Indicates message associated with status.
TaskInstances Array of AutomationTaskInstance objects Indicates instances of tasks associated with this automation instance.

Related Items