API V5 for Flow Development Guide

With API V5 for Flow, admins can manage their content and customize their management processes in powerful, new ways.

Use API V5 Flow for these actions.

1. Import Content Templates
2. Connect external content builders to Account Engagement
3. Copy content and assets between business units
4. Copy assets from Sandbox to Production orgs and vice versa

Build custom user interfaces, create custom tasks, and schedule automated workflows by using Salesforce Flow.

This guide focuses on-screen flow use cases. To learn about other Salesforce Flow use cases, and to learn more about flow in general, refer to these Trailheads.

1. Flow Trail
2. Schedule-Triggered Flows
3. Flow Types

This guide assumes you have a baseline understanding of Salesforce Flow. Flow will seem familiar to users of Engagement Studio, in that it also includes:

1. A Visual Builder Interface using a Canvas
2. Top-to-Bottom Workflow using Steps
3. Salesforce Object Triggers (Flow doesn’t have the concept of triggers within a flow)
4. Three basic concepts for screen flows:
   • Screens - Used to Interact with User and Gather Input
   • Actions - Used to Retrieve Data or Execute an Action
   • Conditions - Used to create criteria to determine a path

Because it’s designed for general processes, Flow is more advanced than Engagement Studio. Note these capabilities.

1. Define objects
2. Add custom actions
3. Perform loops
4. Package Flows

API V5 is integrated into Flow using Apex Invocable Actions, which expose the Account Engagement API to Flow. With Flow, you can perform these general functions.

1. Generate Picklists

• Use: A user can search for and select a record.

• Input:

  • Object Name
  • Business Unit ID

• Output

  • JSON String of Content Name, Content Record IDs

2. Create an Asset

• Use: Creates a content record.

• Action Naming Schema: Create X Record

• Input:

  • Asset ID

3. Read an Asset

• Use: Retrieve all the data for an asset.

• Action Naming Schema: Read X Record

• Input:

  • Asset ID

• Output:

  • Content Record

To store the results of the Read and Create actions, each supported object needs an associated Apex Defined Object Class to represent the data in the object.

• Access to Salesforce org with Marketing Cloud Account Engagement
• User Access to build and run Flows
• User Access to relevant business units
• Install the latest Marketing Cloud Account Engagement Managed Package

Get My Business Unit
Retrieves the list of business units relevant to a given user.

Generate Flow Context
Combine all the variables, and then generate a context that can be used as an input for all the invocable actions.

Get Dropdown Options
Retrieves a list of options for the given object and business unit.

Get Email Template
Retrieves the details of an Email Template.

Copy Email Template
Creates an Email Template by using the provided inputs.

Get Custom Redirect
Retrieves the details of a Custom Redirect.

Copy Custom Redirect
Creates a Custom Redirect by using the provided inputs.

Get Custom Field
Retrieves the details of a Custom Field.

Copy Custom Field
Creates a Custom Field using the provided inputs.

Get Dynamic Content
Retrieves the details of Dynamic Content.

Copy Dynamic Content
Creates new Dynamic Content using the provided inputs.

Get Engagement Studio Program
Retrieves the details of an Engagement Studio Program.

Copy Engagement Studio Program
Creates an Engagement Studio Program using the provided inputs.

Get File
Retrieves the details of a File.

Copy File
Creates a File using the provided inputs.

Get Form
Retrieves the details of a Form.

Copy Form
Creates a Form by using the provided inputs.

Get Form Handler
Retrieves the details of a Form Handler.

Copy Form Handler
Creates a Form Handler using the provided inputs.

Get Layout Template
Retrieves the details of a Layout Template.

Copy Layout Template
Creates a Layout Template using the provided inputs.

Get Landing Page
Retrieves the details of a Landing Page.

Copy Landing Page
Creates a Landing Page using the provided inputs.

These sections detail the unique objects provided in the API V5 for Flow toolkit.

The following is a general class to store picklist values for Account Engagement objects. A picklist output includes a display value that shows the user, and a reference ID to retrieve the record the user selects.

1PicklistOutput {
2    String id;
3    String name;
4    String domain; // to support tracker-domain picklist
5}

The Email Template model represents an Account Engagement Email Template.

1EmailTemplateModel {
2Integer id;
3String name;
4String subject;
5String htmlMessage;
6String textMessage;
7Boolean isOneToOneEmail;
8Boolean isAutoResponderEmail;
9Boolean isDripEmail;
10Boolean isListEmail;
11List<SenderOption> senderOptions;
12Integer trackerDomainId;
13Integer folderId;
14String type;
15Integer campaignId;
16
17    SenderOption {
18        String type;
19        String address;
20        String name;
21}

The custom redirect model represents an Account Engagement Custom Redirect.

1CustomRedirectModel {
2    Integer id;
3    String name;
4    String destinationUrl;
5    Integer folderId;
6    Integer campaignId;
7    Integer trackerDomainId;
8    String vanityUrlPath;
9    String gaCampaign;
10    String gaContent;
11    String gaMedium;
12    String gaSource;
13    String gaTerm;
14}

The Custom Field model represents an Account Engagement Custom Field.

1CustomFieldModel {
2    String fieldId;
3    Integer id;
4    Boolean isRecordMultipleResponses;
5    Boolean isRequired;
6    Boolean isUseValues;
7    String name;
8    String salesforceId;
9    String type;
10    String statusText;
11    String errorMessage;
12}

The File model represents an Account Engagement File.

1FileModel {
2    Integer id;
3    String name;
4    Integer folderId;
5    Integer campaignId;
6    Integer trackerDomainId;
7    String url;
8    String statusText;
9    String errorMessage;
10}

The Engagement Studio Program model represents an Account Engagement Studio Program.

1EngagementStudioProgramModel {
2    Integer id;
3    String name;
4    Integer folderId;
5    String statusText;
6    String errorMessage;
7}

The Form model represents an Account Engagement Form.

1FormModel {
2    Integer id;
3    String name;
4    Integer campaignId;
5    Integer folderId;
6    Integer trackerDomainId;
7    Integer layoutTemplateId;
8    String submitButtonText;
9    String redirectLocation;
10    String thankYouContent;
11    String thankYouCode;
12    String beforeFormContent;
13    String afterFormContent;
14    String fontSize;
15    String fontFamily;
16    String fontColor;
17    String labelAlignment;
18    String radioAlignment;
19    String checkboxAlignment;
20    String requiredCharacter;
21    Boolean showNotProspect;
22    Boolean isAlwaysDisplay;
23    Boolean isCaptchaEnabled;
24    Boolean isCookieless;
25    String statusText;
26    String errorMessage;
27}

The Form Handler model represents an Account Engagement Form Handler.

1FormHandlerModel {
2    Integer id;
3    String name;
4    Integer folderId;
5    Integer campaignId;
6    Integer trackerDomainId;
7    Boolean isDataForwarded;
8    String successLocation;
9    String errorLocation;
10    Boolean isAlwaysEmail;
11    Boolean isCookieless;
12    String statusText;
13    String errorMessage;
14}

The Dynamic Content model represents an Account Engagement Dynamic Content.

1DynamicContentModel {
2    String name;
3    Integer id;
4    String baseContent;
5    String basedOnProspectApiFieldId;
6    Integer folderId;
7    Integer trackerDomainId;
8    List<DynamicContentVariationModel> variations;
9    String statusText;
10    String errorMessage;
11}

The Landing Page model represents an Account Engagement Landing Page.

1LandingPageModel {
2    Integer id;
3    String name;
4    Integer campaignId;
5    Integer formId;
6    Integer layoutTemplateId;
7    String title;
8    String description;
9    Boolean isDoNotIndex;
10    String vanityUrlPath;
11    String scriptFragment;
12    String redirectLocation;
13    Integer trackerDomainId;
14    Integer folderId;
15    String archiveDate;
16    String content;
17    String openingGeneralContent;
18    String statusText;
19    String errorMessage;
20}

The Layout Template model represents an Account Engagement Layout Template.

1LayoutTemplateModel {
2    Integer id;
3    String name;
4    String layoutContent;
5    String formContent;
6    Boolean isIncludeDefaultCss;
7    Integer folderId;
8    String statusText;
9    String errorMessage;
10}

The Flow Context model represents a GenerateFlowContext invocable action.

1FlowContextModel {
2    Boolean isDefaultFlow = false;
3    String accountEngagementSandboxBUCredential;
4    String productionBusinessUnitId;
5    String sandboxBusinessUnitId;
6    Boolean productionToSandbox;
7}

You can find the provided flow, Account Engagement Bulk Asset Copy, from Setup →Flow. This default flow provides a moderately complex example of how a copy flow is built.

The flow just repeats the same basic pattern on multiple assets.

The steps are:

• Determine the Business Unit that contains the assets you want to copy, and the Business Unit that you want to copy those assets into
• Select the assets to copy
• Read the assets to copy
• Configure the assets for copying
• Create the copied assets

To start, pull the available Business Units and select the source and destination.

Next, pull the picklist values used for the rest of the flow.

These queries are made to prepare for selecting and configuring the assets to copy.

• Configuration
  • Campaigns
  • Folders
  • Tracker Domains
• Assets
  • Email Templates
  • Custom Fields
  • Custom Redirects
  • Files
  • Engagement Studio Programs

Select the assets to copy and validate to ensure a copy can occur.

A screen presents a dropdown for each asset using a multi-select picklist, allowing for multiple options per dropdown.

If any assets are selected, the process continues to read the assets.

The following loops, repeated for each asset, pull the asset data from the source business unit.

The loop goes through each asset selected and reads its record from the source business unit, adding it to a new collection.

The loop repeats for each asset so that all the data for copying is available for later steps.

After all the information is read, summary information is presented to confirm the correct files are copied.

From here, configure the campaign, folder, and tracker domain to use in the destination business unit.

The second set of loops go through each copy request and creates the record in the destination business unit.

The loop cycles through the selected asset records, using the field settings as input to the copy action.

The final step records the new records ID and provides success confirmation.

The same patterns apply for custom flows, only with a different set of loops to build a different bulk copy flow. With custom flows, you can also remove the loop to create copies one at a time.

Note: We recommend an understanding of the standard flow before attempting a custom flow.

Create a custom copy flow to move the right assets between business units. The standard process for a copy is to select the assets to copy, read the assets, and then create the assets using the read data.

Select an asset in an external location and copy it into Account Engagement.

Note: This use case requires an invocable action be built for the external builder service to retrieve the desired content.

After the content is received, the remainder of the flow is the same.

1. Configure the asset.
2. Create the asset.

Select an asset URL to embed into another piece of content.

This use case is more advanced and requires development to parse and embed the desired content. However, it’s possible to read the URL for forms, files, and custom redirects to embed them into HTML.

Flows built with API V5 for Flow can be packaged, so you can share them via AppExchange or make it easy to install into production.

The process of packaging a flow is the same as other packages. Under Salesforce Setup, go to Package Manager, and follow these steps.

1. Create a package
2. Add components to the package
3. Select the type Flow Definition.
4. Select your desired Flow Definition.
5. Upload the package
6. Install via the provided URL

j

Get Started

Account Engagement API Use Cases

Authentication

Error Codes and Messages

Version 3 and 4 Overview

Transitioning to V4

Transitioning to V5

Bulk Data Pull

V3/V4 Object Field References

API V5 for Flow Development Guide

Quick Start

Version 3 Docs

Version 4 Docs

Version 5 Docs

Tracking and Consent API

Get Started as an Account Engagement ISV

Extend the Email Builder Experience

Work with Extensibility Features

Salesforce Objects for Account Engagement Development

Additional Resources