Interact with Automation Studio

Use SOAP API to interact with Automation Studio. You can use SOAP API to perform these actions in Automation Studio using 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
• Update an automation
• Pause an automation

Automation Studio must be enabled for your account.

Use these code examples with automations that were created using SOAP API. To interact with these automations, use the NewObjectID value returned when you created the automation using SOAP API. If you don't have this value or if you want to interact with an automation created in the web interface, contact Salesforce Customer Support to retrieve the ID. We recommend that you use SOAP API to create the automations if you plan to use subsequent API calls to interact with those automations.

This sample SOAP envelope shows how to create an automation.

The response indicates the status of the request.

This sample SOAP envelope shows how to perform an automation immediately.

This sample SOAP envelope shows how to get an automation.

The response includes data for the fields specified in the request.

Use the Automation ID and AutomationInstanceID fields to retrieve existing automations.

This sample SOAP envelope shows how to update an automation.

This sample SOAP envelope shows how to pause an automation.