AutomationInstance

The AutomationInstance object defines an automation in Automation Studio for an account.

The only supported operators for the AutomationInstance object are: IN, EQUALS. Complex filters aren't supported.

NameData TypeDescription
AutomationIDxsd:stringIdentifies automation associated with this instance. If you already use ProgramID, it is still supported for migrated accounts.
AutomationSourceAutomationSourceIdentifies source of automation
AutomationTasksAutomationTasks[]Identifies tasks within automation
AutomationTypexsd:stringIdentifies type of automation
ClientClientIDDefines which account owns the automation
CompletedTimexsd:dateTimeIndicates when automation completed
CorrelationIDxsd:stringIdentifies calls involved in a specific asynchronous process
CreatedDatexsd:dateTimeRead-only date and time of the object's creation
CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type
Descriptionxsd:stringDescribes and provides information regarding the object
IDxsd:intRead-only legacy identifier for an object. Not supported on all objects
InteractionObjectIDxsd:stringReturns associated ID for activities within the asynchronous process of the overall conversation or program
IsActivexsd:booleanSpecifies whether the object is active
Keywordxsd:stringReserved for future use
ModifiedDateNullableIndicates the last time object information was modified
Namexsd:stringName of the object or property
NotificationsAutomationNotification[]Indicates notifications to use when automation completes
ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object
ObjectStatexsd:stringReserved for future use
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account
PartnerKeyxsd:stringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by client and stored by system. This property is accessible only via API.
ScheduleScheduleDefinitionIndicates schedule for automation
ScheduledTimexsd:dateTimeKeeps requests in asynchronous queue until time specified in call
StartTimexsd:dateTimeIndicates time this instance of an automation started
Statusxsd:intIndicates status of automation
StatusLastUpdatexsd:dateTimeIndicates date and time status last updated
StatusMessagexsd:stringIndicates message associated with status
TaskInstancesAutomationTaskInstance[]Indicates instances of tasks associated with this automation instance