Interact with Automation Studio
This page contains information about using the SOAP API to interact with Automation Studio within Marketing Cloud.
You must use an active API user on a Marketing Cloud account enabled with Automation Studio for the code samples in this document.
You can view more information on Automation Studio by logging into your Marketing Cloud account, clicking Welcome, and selecting Help.
The code samples in this document refer only to automations created via the SOAP API. To interact with these automations, you must use the NewObjectID value returned during the SOAP API creation process. If you don't record this value or wish to interact with automation created within Marketing Cloud, you must contact Global Support to retrieve the applicable value. Marketing Cloud recommends creating the automations using the SOAP API if you wish to interact with those automations with more API calls.
You can use the SOAP API to perform the following actions within the Automation Studio via your own application or development environment:
- Create an automation, including all steps and tasks included in the automation
- Perform an automation immediately
- Retrieve the status of an automation already in progress
- Retrieve the status of a single automation instance
- Schedule an existing automation
- Update an automation
- Pause an automation
The sample code below starts the specified automation. To perform a stop for the specified option, change the string action in the code to stop.
Use Automation ID and AutomationInstanceID to retrieve existing automations. If your account has been migrated, ProgramID is still supported.