The Automation object defines an Automation Studio automation. To update, delete, or perform an automation, you must have the Automation Studio | Automation permission.

The only supported operators for the Automation object are IN and EQUALS. Complex filters aren't supported.

NameData TypeDescription
AutomationSourceStringIdentifies the source of the automation.
AutomationTasksArray of AutomationTask objectsIdentifies the tasks within the automation.
AutomationTypeStringIdentifies type of automation.
ClientClientIDDefines which account owns the automation.
CorrelationIDStringIdentifies calls involved in a specific asynchronous process.
CreatedDateStringThe date and time when the object was created. Read-only.
CustomerKeyStringUser-supplied unique identifier for an object within an object type.
DescriptionStringDescribes the object.
IDIntegerRead-only legacy identifier for an object. Not supported on all objects.
InteractionObjectIDStringReturns associated ID for activities within the asynchronous process of the overall conversation or program.
IsActiveBooleanSpecifies whether the object is active.
KeywordStringReserved for future use.
ModifiedDateStringIndicates the last time the object information was modified.
NameStringName of the object or property.
NotificationsArray of AutomationNotification objectsIndicates notifications to use when automation completes.
ObjectStateStringReserved for future use.
OwnerOwnerDescribes the account ownership of a subscriber in an account that is managed on your behalf.
PartnerKeyStringA unique identifier for an object, provided by a partner. This property can only be accessed by using the API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. This property can only be accessed by using the API.
ProgramIDStringAn identifier for the object. Read-only.
ScheduleScheduleDefinitionThe schedule for the automation.
ScheduledTimeStringThe date and time at which the request must be processed. Specify the value in ISO 8601 format with UTC time or a timezone offset. The specified time can be up to 30 days in the future.
StatusIntegerA code that indicates the status of the automation. See (Status Codes)[#status-codes] for more information.

The values of the ScheduledTime and CreatedDate properties are always shown as "0001-01-01T00:00:00.000".

The Status property can contain the values in this table.

-1The automation failed.
0The automation failed while being built.
1The automation is being built.
2The automation is ready to start.
3The automation is running.
4The automation has been paused.
5The automation has been stopped.
6The automation is scheduled.
7The automation is waiting for a trigger.
8The trigger for the automation is inactive.