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 filter is not supported.

Properties

NameData TypeDescription
AutomationIDxsdIdentifies 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
AutomationTypexsdIdentifies type of automation
ClientClientIDDefines which account owns the automation
CompletedTimexsdIndicates when automation completed
CorrelationIDxsdIdentifies calls involved in a specific asynchronous process
CreatedDatexsdRead-only date and time of the object's creation
CustomerKeyxsdUser-supplied unique identifier for an object within an object type
DescriptionxsdDescribes and provides information regarding the object
IDxsdRead-only legacy identifier for an object. Not supported on all objects
InteractionObjectIDxsdReturns associated ID for activities within the asynchronous process of the overall conversation or program
IsActivexsdSpecifies whether the object is active
KeywordxsdReserved for future use
ModifiedDateNullableIndicates the last time object information was modified
NamexsdName of the object or property
NotificationsAutomationNotification[]Indicates notifications to use when automation completes
ObjectIDxsdSystem-controlled, read-only text string identifier for object
ObjectStatexsdReserved for future use
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account
PartnerKeyxsdUnique 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
ScheduledTimexsdKeeps requests in asynchronous queue until time specified in call
StartTimexsdIndicates time this instance of an automation started
StatusxsdIndicates status of automation
StatusLastUpdatexsdIndicates date and time status last updated
StatusMessagexsdIndicates message associated with status
TaskInstancesAutomationTaskInstance[]Indicates instances of tasks associated with this automation instance