The Automation object defines an automation in Automation Studio for an account. To update, delete, or perform an Automation where your account has the Programs_30 feature and AutomationSourceType is not Playbooks, you need the corresponding Automation Studio | Automation permissions.

The only supported operators for the Automation object are: IN, EQUALS. Complex filter is not supported.

NameData TypeDescription
AutomationSourceAutomationSourceIdentifies source of automation.
AutomationTasksAutomationTasks[]Identifies tasks within automation.
AutomationTypexsdIdentifies type of automation.
ClientClientIDDefines which account owns the automation.
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.
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.
ProgramIDxsdSystem-controlled, read-only text string identifier for object.
ScheduleScheduleDefinitionIndicates schedule for automation.
ScheduledTimexsdKeeps requests in asynchronous queue until time specified in call.
StatusxsdIndicates status of automation.

The schedule property is non-retrievable, so ScheduledTime and CreatedDate always show as "0001-01-01T00:00:00.000".

The Status property can contain these values:

CodeStatus TypeMessage
-1ErrorProgram errored out.
0BuildingErrorProgram errored out during building.
1BuildingProgram building with activities, schedules, and other elements.
2ReadyProgram ready to start.
3RunningProgram running.
4PausedProgram paused from running state.
5StoppedProgram stopped.
6ScheduledProgram scheduled.
7Awaiting TriggerProgram waiting for a trigger.
8InactiveTriggerProgram trigger inactive.