# mulesoft Salesforce Marketing Cloud Connector - Full Documentation

<!-- document id=4b9606f7e1c91883dee3e205efae75125e43775b8a1e54f8a14c5e8869e5b240 url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/index.md -->

---
product: Salesforce Marketing Cloud Connector
version: 4.1
---

# Salesforce Marketing Cloud Connector 4.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Marketing Cloud (Marketing Cloud Connector) enables you to connect
to the Marketing Cloud API web services (now known as the Marketing Cloud API), which is also known
as the Salesforce Marketing Cloud. This connector exposes convenient operations for exploiting the
capabilities of Salesforce Marketing Cloud.

Release Notes:
[Salesforce Marketing Cloud Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-mktg-connector-release-notes-mule-4)  
Exchange:
[Salesforce Marketing Cloud Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-marketing-cloud-connector/)

## Before You Begin

To use this information, you should be familiar with Salesforce Marketing, Mule runtime engine
(Mule), Anypoint Connectors, Anypoint Studio, Mule concepts, elements in a Mule flow, and Global
Elements.

You need login credentials to test your connection to your target resource.

For software requirements and compatibility information, see the Connector Release Notes.

## Common Use Cases for the Connector

Common use cases for Salesforce Marketing Cloud Connector include:

- **Customer Insights**

  Get a complete, unified view of the customer, such as their purchase habits, lifestyle, or
  subscriptions, and continually adjust to a customer’s journey in real time.

- **Personalization**

  Create personalized, targeted email campaigns by integrating with back-office data from external
  systems, such as SAP, Oracle E-Business Suite, NetSuite, and Workday.

- **Marketing Automation**

  Save time by automating your business processes while engaging with your customers. For example,
  you can schedule future emails for your customers.

For examples of these use cases, refer to
[Salesforce Marketing Cloud Connector Examples](https://docs.mulesoft.com/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-examples).

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-marketing-cloud-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most
up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## What’s New in this Connector

This connector version has the same operations as the 2.x versions, but groups some of them
differently. Also, the connector no longer uses FuelSDK. Instead, the connector performs the SOAP
requests itself.

## Add and Configure the Connector in a Studio Project

To add the connector to a Studio project:

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "marketing" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the connector to the Studio Canvas.

2.  To create a global element for the connector, complete these fields:

    - Basic Authentication (Username Password):

      - **Username** - Username used to initialize the session

      - **Password** - Password used to authenticate the

      - **Service URL** - The URL of the service on Salesforce Marketing Cloud to be accessed from
        the connector.

        ![Global element properties window for Basic Authentication](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-user-pass-config.png)

    - OAuth Client Credentials authentication:

      - **Service URL** - URL of the Salesforce Marketing Cloud service that the connector will
        access\*\* **Client Id** - Client ID for the installed package

      - **Client secret** - Client secret for the installed package

      - **Token url** - URL of the endpoint that provides the access tokens

        ![Global element properties window for OAuth Client Credentials](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-oauth-client-credentials-config.png)

### Use Case - Create an Object

1.  Create a new Mule project by selecting **File** > **New** > **Mule Project**.

2.  Supply a name for your project and click **Finish**.

3.  Open the pom.xml file and add the following dependency for Mule Salesforce Marketing Connector,
    where `x.x.x` is the current connector version:

    ```xml
    <dependency>
        <groupId>org.mule.connectors</groupId>
        <artifactId>mule-module-sfdc-marketing-cloud-connector</artifactId>
        <version>x.x.x</version>
        <classifier>mule-plugin</classifier>
    </dependency>
    ```

4.  Navigate through the project’s structure and double-click
    `src/main/app/smc-usecase-create-object.xml`.

5.  Search for the **HTTP** component in the Mule Palette view.

6.  Drag the **Listener** operation onto the canvas.

7.  Search for **Transform Message** and drag the component after the **Listener**.

8.  Search for **Salesforce Marketing Cloud** and drag the **Create entities** operation after
    **Transform Message**.

9.  Add a **Transform Message** component after **Create**.

10. Double-click on the **Listener** component.

    ![HTTP Listener component properties window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-http-listener-config.png)

11. Click ![Plus button](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-as-plus-button.png) next to the **Connector
    configuration** field.

12. Specify the **Host** as localhost and **Port** as `8081`, then click **OK**.

13. Specify the **Path** as `/create`.

14. Double-click **Create**.

    ![Create entities properties window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-smc-create-config.png)

15. Click the ![Plus button](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-as-plus-button.png) next to Connector
    configuration.

    ![Global element properties window for Basic Authentication](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-user-pass-config.png)

16. Specify the required fields with the credentials for your organization and click **OK**.

17. From the **Object type** drop-down select `List`.

18. Double-click **Transform Message** (to the left of **Create** in the flow) and configure as
    shown below:

    ![Window of Transform message before configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-transform-before-config.png)

19. Double-click **Transform Message** (to the right of **Create** in the flow) and configure as
    shown below:

    ![Window of Transform message after configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-transform-after-config.png)

20. Deploy the app.

21. Use a REST client to make a POST request to `x-www-form-urlencoded to localhost:8081/create`
    with the following parameter payload: `listName=testlist`.

    For example, `curl -d listName=MyName-Test localhost:8081/create`.

22. Go to your instance and check that the list was created.

You can use a similar flow for other connector operations, such as Upload and Delete, but you must
change the Object Type in the Salesforce Marketing Cloud to the name of the object that you are
going to create, and remap fields on the Transform Message component as needed.

### Use Case: XML

Check your code against the app’s XML representation:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">
	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config">
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config
    name="Salesforce_Marketing_Cloud_Config"
    doc:name="Salesforce Marketing Cloud Config" >
		<sfdc-marketing-cloud:basic-connection
      username="${config.username}"
      password="${config.password}"
      serviceUrl="${config.endpoint}" />
	</sfdc-marketing-cloud:config>
	<flow name="smc-usecase-create-objectFlow">
		<http:listener doc:name="Listener"
      config-ref="HTTP_Listener_config"
      path="/create"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[{
	ListName: payload.listName
}]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sfdc-marketing-cloud:create
      doc:name="Create"
      config-ref="Salesforce_Marketing_Cloud_Config"
      objectType="List"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

## Known Issues and Limitations

Salesforce Marketing Cloud Connector has some limitations, including when:

- Working with subclasses inside complex fields

- Trying to retrieve fields from a hierarchy

- Attempting to return an Automation object.

### Working with Subclasses Inside Complex Fields

Some objects in Salesforce Marketing Cloud have complex fields, such as the Recurrence field, which
belong to a base class. DataSense can only bring up fields specific to the base class.

To use additional fields that belong to a subclass of a base class, manually add the desired fields
to the Transform Message component. For Salesforce Marketing Cloud to know that you want to work
with a subclass and recognize the fields you added, you must also add a field called
concreteClassType of type String whose value is the name of the subclass.

See [Providing a Subclass as a Type to a Complex Field](#providing-subclass) for an example
detailing how to achieve this.

### Retrieve Operation Limitations

The Retrieve operation enables you to retrieve records in a SQL query-like fashion. When you use the
Retrieve operation, Salesforce Marketing Cloud prevents the retrieval of fields that are part of a
hierarchy. For example, the Subscriber object has a complex structure:

![Subscriber structure](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-as-subscriber-structure.png)

The API only allows you to query fields on the first level, such as `EmailAddress` or
`SubscriberKey`, but not fields such as `Attributes.Name`.

The `Retrieve` operation supports filters for querying the data. However the filters do not behave
like an SQL filter condition. For example, a clause such as `WHERE 1=1` works in SQL, but results in
an error in Salesforce Marketing Cloud because the API doesn’t support it. In this example, the
operand to the left of the equal sign must be a valid property of the Salesforce data extension
(SFDE).

When executing the request with the `WHERE 1=1` clause, the filter expects a property. It is
transformed into the following request:

`<Filter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleFilterPart"> <Property>1</Property> <SimpleOperator>equals</SimpleOperator> <Value>1</Value> </Filter>`.

The response is:

\`<OverallStatus>Error: The Filter Property '1' is not a retrievable property.</OverallStatus>\`.

When filtering the results of a query, only the following operators are supported in WHERE clauses:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Salesforce Marketing API equivalent</th></tr></thead><tbody><tr><td><p>=</p></td><td><p>equals</p></td></tr><tr><td><p>&lt;&gt;</p></td><td><p>notEquals</p></td></tr><tr><td><p>&gt;</p></td><td><p>greaterThan</p></td></tr><tr><td><p>&gt;=</p></td><td><p>greaterThanOrEqual</p></td></tr><tr><td><p>&lt;</p></td><td><p>lessThan</p></td></tr><tr><td><p>⇐</p></td><td><p>lessThanOrEqual</p></td></tr><tr><td><p>like</p></td><td><p>like</p></td></tr></tbody></table>

> [!IMPORTANT] This connector uses DSQL Query syntax instead of native Salesforce OQL and does not
> send the SQL query to the Salesforce server as is. Instead, the query is parsed and transformed
> into an XML object before it is sent. Because of this, any filters that are not included in the
> table above or any SQL syntax features, such as TOP(x), LIMIT, OFFSET, ALIAS, or JOINs, are
> unsupported. For more details, refer to the
> [Salesforce API Guide](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/retrieverequest.html#properties).

### Server Results Containing an Automation Object

Server results that contain an Automation object cause an exception to be thrown. When performing an
operation, such as Create or Delete, on an Automation object, the returned result contains the
structure of the Automation object you acted upon. The server also returns an additional field in
the Automation object called isPlatformObject that is not recognized by the WSDL.

To bypass this issue, make all operations that directly use an Automation object asynchronous. If an
operation is asynchronous, the immediate response of the operation is `Operation Queued`.

For more information, see [Asynchronous Operations](#asynchronous-operations).

## Common Use Cases

Use Salesforce Marketing Cloud Connector operations for the following common use cases:

- `Configure action` operation - Calls the Configure method with Create, Delete, or Update as the
  value of the Action parameter when connected to the Marketing Cloud API SOAP web service.

- `Create entities` operation - Creates new objects on the Marketing Cloud API web server.

- `Delete objects` operation - Deletes existing objects on the Marketing Cloud API web server.

- `Perform operation` - Calls the Perform method with the GetMaxCount, Start, or Stop as the value
  of the Action parameter when connected to the Marketing Cloud API SOAP web service.

- `Retrieve entities` operation - Retrieves objects from the Marketing Cloud API web server in a SQL
  query-like fashion.

- `Schedule start` operation - Calls the Schedule method with Start as the value of the Action
  parameter when connected to the Marketing Cloud API SOAP web service.

- `Update entities` operation - Updates existing objects on the Marketing Cloud API web server.

- `Upsert entities` operation - Creates objects on the Marketing Cloud API web server if the objects
  do not already exist, or updates existing objects on the server.

### Add a Proxy

To use a proxy server, set the following configuration properties on the **Advanced** tab of your
configuration:

![Proxy fields configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-proxy.png)

### Providing a Subclass as a Type to a Complex Field

Suppose you want to schedule an existing Automation that sends emails to a subscriber list once per
minute. To do this, add a Schedule Reference to the connector through a flow variable:

![Schedule Start Automation configuration window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-schedule-start-automation.png)

Use the **Recurrence** field in **ScheduleDefinition** to provide information such as how much time
to pass between sending emails. The **Recurrence** field is a complex field that has no structure.

To specify a MinutelyRecurrence instead of a Recurrence:

- Manually add the fields belonging to the MinutelyRecurrence class.

- Add an additional field called concreteClassType of type String whose value is the name of the
  subclass.

The mapping for the ScheduleDefinition looks like this in the example:

![Schedule definition](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-schedule-definition-transform-config.png)

This map has a field called `minuteInterval` that belongs to a subclass of Recurrence called
`MinutelyRecurrence`.

For the connector to use the MinutelyRecurrence object, you must also add the concreteClassType
field with `MinutelyRecurrence` as the value.

### Asynchronous Operations

Most operations are synchronous by default, meaning that the connector waits for the result of the
operation. For more details regarding the operations of the Marketing Cloud API, access the
Salesforce Marketing Cloud Methods documentation.

To specify that you want an operation to behave asynchronously, use the Options parameter for the
operation.

The following example creates a list of Automation objects to provide in the payload. Because the
result of any operation that works directly with Automation objects throws an exception caused by
the presence of an unknown field, the example uses the CreateOptions parameter to make the call
asynchronous. In this example, the CreateOptions value is provided in a variable called `vars`.

![Create options field with value specified](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-3-create-automation-config.png)

This mapping for CreateOptions in vars looks like this:

- The requestType field determines the type of call (SYNCHRONOUS or ASYNCHRONOUS).

- The conversationID field assigns a unique identifier to the asynchronous call.

You can group asynchronous calls together using the conversationID, callsInConversation, and
sequenceCode fields. For example, suppose you want to make five asynchronous calls to the server,
execute the calls together, and specify their execution order. To do this:

1.  Assign the same conversationID to each call.

2.  Set the callsInConversation field to 5.

3.  Use the sequenceCode field to order the calls.

The following example has a single call, so it passes a value of 1 to callsInConversation and
sequenceCode.

![Create options output](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-as-create-automation-options.png)

The Options parameter has more functionality than shown in this example. For more information, see
the Salesforce Marketing Cloud Objects documentation.

## See Also

- [Salesforce Get Started with the SOAP Web Services API](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/getting_started_developers_and_the_exacttarget_api.html)

- [Salesforce API Integration](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/api-integration.html).

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=b904ab130cecdf0b94eb2bd75188460af3452cf84fdbddd5d2329cbe33b11d0f url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-examples.md -->

---
product: Salesforce Marketing Cloud Connector
version: 4.1
---

# Salesforce Marketing Cloud Connector 4.1 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following examples show several Mule flows for Salesforce Marketing Cloud Connector:

- [Create a List](#create-list)

- [Retrieve a List](#retrieve-list)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    config-with-oauth.clientId=<clientId used to initialize the connection>
    config-with-oauth.clientSecret=<clientSecret used to authenticate the user>
    config-with-oauth.soapEndpoint=<SOAP endpoint address>
    config-with-oauth.authEndpoint=<Authentication endpoint>

    This may vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter
    `Salesforce Marketing Cloud`.

3.  Add **Salesforce Marketing Cloud Connector** to the **Selected modules** section and click
    **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Marketing Cloud** and click **OK**.

6.  Enter the values to configure either Basic Authentication or OAuth Client Credentials.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce
    Marketing Cloud API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select TLS Configuration > Edit inline.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Create a List

This Mule flow creates a list for storing subscribers.

> [!NOTE] The default value for the List type is `Public`, which makes the list visible to all
> subscribers. After creating the list, note the list ID to use it in other operations.

This example uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests

- **Logger**  
  Shows the HTTP response from **HTTP Listener**

- **Transform Message**  
  Outputs the data in Java

  %dw 2.0 output application/java
  ---

  \[{

      ListClassification: payload.listClassification,
      ListName: payload.listName,
      "Type": payload.listType

  }\]

- **Create entities**  
  Creates new objects on the Salesforce Marketing Cloud API web server

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Object type</strong></p></td><td><div><div><p><code>List</code></p></div></div></td></tr><tr><td><p><strong>Connector Configuration</strong></p></td><td><div><div><p><code>Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config</code></p></div></div></td></tr><tr><td><p><strong>Api objects</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

- **Transform Message**  
  Outputs the data in JSON

  output application/json
  ---

  payload

![Studio flow for the Create List operation](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-create-list.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
      xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
  http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">

	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="2d500821-46be-4da2-a983-832ca1d829de" >
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config name="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" doc:name="Salesforce Marketing Cloud Sfdc marketing cloud config" doc:id="8c951adc-306a-4212-a33f-4be4b19a0076" >
		<sfdc-marketing-cloud:oauth-client-credentials-connection serviceUrl="${config-with-oauth-v2.serviceUrl}">
			<sfdc-marketing-cloud:oauth-client-credentials clientId="${config-with-oauth-v2.clientId}"
														   clientSecret="${config-with-oauth-v2.clientSecret}"
														   tokenUrl="${config-with-oauth-v2.tokenUrl}" />
		</sfdc-marketing-cloud:oauth-client-credentials-connection>
	</sfdc-marketing-cloud:config>

    <flow name="salesforce-marketing-cloud-oauth-demo-create-list-flow">
        <http:listener path="/create-list" doc:name="HTTP" config-ref="HTTP_Listener_config"/>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
        <ee:transform doc:name="Transform Message" doc:id="fab54a8d-4f2d-45cf-9496-9d407bf5837f" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[{

	ListClassification: payload.listClassification,
	ListName: payload.listName,
	"Type": payload.listType
}]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <sfdc-marketing-cloud:create config-ref="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" objectType="List" doc:name="Salesforce Marketing Cloud"/>
        <ee:transform doc:name="Transform Message" doc:id="a61ae2f3-0821-4884-9a4c-2306071c7ec8" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
    </flow>
</mule>
```

## Retrieve a List

This Mule flow retrieves the ID of a list to use in other operations.

This example uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests

- **Logger**  
  Shows the HTTP response from **HTTP Listener**

- **Transform Message**  
  Outputs the data in Java

  %dw 2.0 output application/java
  ---

  { query: "SELECT ID FROM List WHERE ListName ='" ++ payload.listName ++ "'" }

- **Retrieve entities**  
  Retrieves objects from the Salesforce Marketing Cloud API web server using an SQL query

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Connector Configuration</strong></p></td><td><div><div><p><code>Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config</code></p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p><code>#[payload.query]</code></p></div></div></td></tr></tbody></table>

- **Transform Message**  
  Outputs the data in JSON format

  %dw 2.0 output application/json
  ---

  payload

![Studio flow for the Retrieve List operation](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/_images/salesforce-mktg-retrieve-list.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
      xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
  http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">

	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="651f3647-d4c9-4536-8d6b-bee43c422625" >
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config name="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" doc:name="Salesforce Marketing Cloud Sfdc marketing cloud config" doc:id="7ef81352-ca1d-4134-bccb-b211a1951a60" >
		<sfdc-marketing-cloud:oauth-client-credentials-connection serviceUrl="${config-with-oauth-v2.serviceUrl}">
			<sfdc-marketing-cloud:oauth-client-credentials clientId="${config-with-oauth-v2.clientId}"
														   clientSecret="${config-with-oauth-v2.clientSecret}"
														   tokenUrl="${config-with-oauth-v2.tokenUrl}" />
		</sfdc-marketing-cloud:oauth-client-credentials-connection>
	</sfdc-marketing-cloud:config>

    <flow name="salesforce-marketing-cloud-oauth-demo-retrieve-list-flow">
        <http:listener path="/retrieve-list" doc:name="HTTP" config-ref="HTTP_Listener_config"/>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
        <ee:transform doc:name="Transform Message" doc:id="fe31d1a8-d189-4fbd-b96f-99c2eac092e1" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
{
	query: "SELECT ID FROM List WHERE ListName ='" ++ payload.listName ++ "'"
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <sfdc-marketing-cloud:retrieve doc:name="Salesforce Marketing Cloud" config-ref="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config">
			<sfdc-marketing-cloud:query>#[payload.query]</sfdc-marketing-cloud:query>
		</sfdc-marketing-cloud:retrieve>
        <ee:transform doc:name="Transform Message" doc:id="d05834f2-3d96-4e95-bd3b-48057d4ca34e" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
    </flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8b6dddbd558da98bc1b4f08a0117f459dfb681fbd9f6259ef364798b988a789e url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-reference.md -->

---
product: Salesforce Marketing Cloud Connector
version: 4.1
---

# Salesforce Marketing Cloud Connector 4.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud Connector) enables you
to connect to the Salesforce Marketing Cloud. This connector exposes convenient operations for
exploiting the capabilities of Salesforce Marketing Cloud.

## Configuration

Default Configuration for Salesforce Marketing Cloud Connector.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#Config_Basic">Basic Authentication</a></p></li><li><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></li></ul></div></div></td><td><div><div><p>Connection types for this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read timeout time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID used to reference this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Basic Authentication Connection Type

Uses a username and a password for connection.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Service URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Proxy configuration</strong></p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy Configuration</a></p></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>WSDL file URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends <code>/etframework.wsdl</code> to the end.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to initialize the session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate the user.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth Client Credentials Connection Type

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

Uses a client ID, client secret, and token URL for connection.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Service URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Proxy configuration</strong></p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy Configuration</a></p></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>WSDL file URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends <code>/etframework.wsdl</code> to the end.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client ID, as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client secret, as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the service provider’s token endpoint.</p></div></div></td><td><div><div><p><code>https://{domain}.auth.marketingcloudapis.com/v2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Sources

- [On modified object](#ModifiedObjectListener)

- [On new object](#NewObjectListener)

### On modified object

`<sfdc-marketing-cloud:modified-object-listener>`

Listener for modified objects.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Since</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a date in the <code>yyyy-MM-dd HH:mm:ss</code> format, for example, <code>2017-03-17 16:30:40</code>, to retrieve the selected objects.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>Scheduling Strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

### On new object

`<sfdc-marketing-cloud:new-object-listener>`

Listener for new objects.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Since</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a date in the <code>yyyy-MM-dd HH:mm:ss</code> format, for example, <code>2017-03-17 16:30:40</code>, to retrieve the selected objects.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>Scheduling Strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

## Operations

- [Configure action](#Configure)

- [Create entities](#Create)

- [Delete objects](#Delete)

- [Perform action](#Perform)

- [Retrieve entities](#Retrieve)

- [Schedule start action](#ScheduleStart)

- [Unauthorize](#Unauthorize)

- [Update entities](#Update)

- [Upsert entities](#Upsert)

### Configure action

`<sfdc-marketing-cloud:configure>`

Allows the configuration of actions.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Configurations</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more configurations to update.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Configure Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Action</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of action to perform.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object the action is performed on.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Create entities

`<sfdc-marketing-cloud:create>`

Creates one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to create.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>CreateOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Delete objects

`<sfdc-marketing-cloud:delete>`

Deletes one or more API objects from your organization’s data.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object to delete.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DeleteOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Perform action

`<sfdc-marketing-cloud:perform>`

Performs an action on a determined type of object.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Definitions</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more definitions for the operation.</p></div></div></td><td><div><div><p><code>Service URL[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Perform Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Action</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of action to perform.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object the action is performed on.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Retrieve entities

`<sfdc-marketing-cloud:retrieve>`

Enables the retrieval of a single object type. This operation retrieves specified object properties
only. You can apply filters to ensure that only relevant results are returned. Only the properties
that have values for the object are returned. If an object that is requested does not exist, no
results are returned.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Query describing the objects that you want to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>RetrieveOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>Non-Repeatable Iterable</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Schedule start action

`<sfdc-marketing-cloud:schedule-start>`

Schedules an action or an event to occur at a specific time.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object on which to do a schedule.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Interactions</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more interactions in the operation.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Definitions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Schedule definition used for the operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schedule Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Unauthorize

`<sfdc-marketing-cloud:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it is impossible to
execute any operation for that user without repeating the authorization dance.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

### Update entities

`<sfdc-marketing-cloud:update>`

Updates one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object to update.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>UpdateOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Upsert entities

`<sfdc-marketing-cloud:upsert>`

Upserts one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud. This operation performs
> **Create** with the `SaveAction` in the **CreateOptions** for the fields set to `UPDATE_ADD`.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to upsert.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>UpsertOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

## Object Types

- [Crl File](#CrlFile)

- [Custom Ocsp Responder](#CustomOcspResponder)

- [Error Mapping](#ErrorMapping)

- [Expiration Policy](#ExpirationPolicy)

- [Key Store](#KeyStore)

- [Proxy Configuration](#ProxyConfiguration)

- [Reconnect](#reconnect)

- [Reconnect Forever](#reconnect-forever)

- [Reconnection](#Reconnection)

- [Redelivery Policy](#RedeliveryPolicy)

- [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier)

- [Repeatable File Store Iterable](#RepeatableFileStoreIterable)

- [Repeatable In Memory Iterable](#RepeatableInMemoryIterable)

- [Standard Revocation Check](#StandardRevocationCheck)

- [TLS](#Tls)

- [Trust Store](#TrustStore)

### Crl File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

Configures the error mapping of the connector.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div><div><p>Source of the error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Target of the error.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Proxy Configuration

Configures a proxy for outbound connections.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname or IP address of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of hosts that the proxy must not be used against.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Ntlm Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Domain to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a <code>REDELIVERY_EXHAUSTED</code> error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>One or more expressions that determine if a message was redelivered. This property can be set only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was
redelivered.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule uses a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. You can set this property only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

Configures the repeatable file store iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

Configures the repeatable in memory iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the <strong>Buffer Size Increment</strong> attribute, with an upper limit of <strong>Max In Memory Size</strong>. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand. A <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full.</p></div></div></td><td><div><div><p><code>100</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory to use. If more than that is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=bad8772d9b4d40e15a80685553adce022f74eb593a5d3d0ac851107e971520ff url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/index.md -->

---
product: Salesforce Marketing Cloud Connector
version: 5.0
is-latest-version: true
---

# Salesforce Marketing Cloud Connector 5.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Marketing Cloud (Marketing Cloud Connector) enables you to connect
to the Marketing Cloud API web services (now known as the Marketing Cloud API), which is also known
as the Salesforce Marketing Cloud. This connector exposes convenient operations for exploiting the
capabilities of Salesforce Marketing Cloud.

Release Notes:
[Salesforce Marketing Cloud Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/salesforce-mktg-connector-release-notes-mule-4)  
Exchange:
[Salesforce Marketing Cloud Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-sfdc-marketing-cloud-connector/)

## Before You Begin

To use this information, you should be familiar with Salesforce Marketing, Mule runtime engine
(Mule), Anypoint Connectors, Anypoint Studio, Mule concepts, elements in a Mule flow, and Global
Elements.

You need login credentials to test your connection to your target resource.

For software requirements and compatibility information, see the Connector Release Notes.

## Common Use Cases for the Connector

Common use cases for Salesforce Marketing Cloud Connector include:

- **Customer Insights**

  Get a complete, unified view of the customer, such as their purchase habits, lifestyle, or
  subscriptions, and continually adjust to a customer’s journey in real time.

- **Personalization**

  Create personalized, targeted email campaigns by integrating with back-office data from external
  systems, such as SAP, Oracle E-Business Suite, NetSuite, and Workday.

- **Marketing Automation**

  Save time by automating your business processes while engaging with your customers. For example,
  you can schedule future emails for your customers.

For examples of these use cases, refer to
[Salesforce Marketing Cloud Connector Examples](https://docs.mulesoft.com/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-examples).

## POM File Information

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-sfdc-marketing-cloud-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most
up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `<connector-name>`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## What’s New in this Connector

Salesforce Marketing Cloud Connector 5.0 is a major release that requires Java 17 and Mule runtime
engine 4.9.0 or later. The same operations from the 4.x release are preserved. Key changes in this
release include:

- The Spring Framework is upgraded to version 6.x, which requires Java 17 as a minimum.

- The connector no longer depends on FuelSDK. Instead, it uses CXF-generated classes from the
  connector WSDL to perform SOAP requests directly.

- The deprecated `omitInternalIdFromCustomFields` parameter is removed.

- Multiple libraries are upgraded to address security vulnerabilities. For a full list, see
  [Upgrading and Migrating Salesforce Marketing Cloud Connector to 5.x](https://docs.mulesoft.com/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-upgrade-migrate).

## Add and Configure the Connector in a Studio Project

To add the connector to a Studio project:

1.  In Studio, create a Mule project.

2.  In the Mule Palette view, click **(X) Search in Exchange**.

3.  In **Add Modules to Project**, type "marketing" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

### Configure the Connector in Studio

1.  Drag the connector to the Studio Canvas.

2.  To create a global element for the connector, complete these fields:

    - Basic Authentication (Username Password):

      - **Username** - Username used to initialize the session

      - **Password** - Password used to authenticate the

      - **Service URL** - The URL of the service on Salesforce Marketing Cloud to be accessed from
        the connector.

        ![Global element properties window for Basic Authentication](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-user-pass-config.png)

    - OAuth Client Credentials authentication:

      - **Service URL** - URL of the Salesforce Marketing Cloud service that the connector will
        access\*\* **Client Id** - Client ID for the installed package

      - **Client secret** - Client secret for the installed package

      - **Token url** - URL of the endpoint that provides the access tokens

        ![Global element properties window for OAuth Client Credentials](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-oauth-client-credentials-config.png)

### Use Case - Create an Object

1.  Create a new Mule project by selecting **File** > **New** > **Mule Project**.

2.  Supply a name for your project and click **Finish**.

3.  Open the pom.xml file and add the following dependency for Mule Salesforce Marketing Connector,
    where `x.x.x` is the current connector version:

    ```xml
    <dependency>
        <groupId>org.mule.connectors</groupId>
        <artifactId>mule-module-sfdc-marketing-cloud-connector</artifactId>
        <version>x.x.x</version>
        <classifier>mule-plugin</classifier>
    </dependency>
    ```

4.  Navigate through the project’s structure and double-click
    `src/main/app/smc-usecase-create-object.xml`.

5.  Search for the **HTTP** component in the Mule Palette view.

6.  Drag the **Listener** operation onto the canvas.

7.  Search for **Transform Message** and drag the component after the **Listener**.

8.  Search for **Salesforce Marketing Cloud** and drag the **Create entities** operation after
    **Transform Message**.

9.  Add a **Transform Message** component after **Create**.

10. Double-click on the **Listener** component.

    ![HTTP Listener component properties window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-http-listener-config.png)

11. Click ![Plus button](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-as-plus-button.png) next to the **Connector
    configuration** field.

12. Specify the **Host** as localhost and **Port** as `8081`, then click **OK**.

13. Specify the **Path** as `/create`.

14. Double-click **Create**.

    ![Create entities properties window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-smc-create-config.png)

15. Click the ![Plus button](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-as-plus-button.png) next to Connector
    configuration.

    ![Global element properties window for Basic Authentication](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-user-pass-config.png)

16. Specify the required fields with the credentials for your organization and click **OK**.

17. From the **Object type** drop-down select `List`.

18. Double-click **Transform Message** (to the left of **Create** in the flow) and configure as
    shown below:

    ![Window of Transform message before configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-transform-before-config.png)

19. Double-click **Transform Message** (to the right of **Create** in the flow) and configure as
    shown below:

    ![Window of Transform message after configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-transform-after-config.png)

20. Deploy the app.

21. Use a REST client to make a POST request to `x-www-form-urlencoded to localhost:8081/create`
    with the following parameter payload: `listName=testlist`.

    For example, `curl -d listName=MyName-Test localhost:8081/create`.

22. Go to your instance and check that the list was created.

You can use a similar flow for other connector operations, such as Upload and Delete, but you must
change the Object Type in the Salesforce Marketing Cloud to the name of the object that you are
going to create, and remap fields on the Transform Message component as needed.

### Use Case: XML

Check your code against the app’s XML representation:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xmlns:http="http://www.mulesoft.org/schema/mule/http"
xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">
	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config">
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config
    name="Salesforce_Marketing_Cloud_Config"
    doc:name="Salesforce Marketing Cloud Config" >
		<sfdc-marketing-cloud:basic-connection
      username="${config.username}"
      password="${config.password}"
      serviceUrl="${config.endpoint}" />
	</sfdc-marketing-cloud:config>
	<flow name="smc-usecase-create-objectFlow">
		<http:listener doc:name="Listener"
      config-ref="HTTP_Listener_config"
      path="/create"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[{
	ListName: payload.listName
}]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<sfdc-marketing-cloud:create
      doc:name="Create"
      config-ref="Salesforce_Marketing_Cloud_Config"
      objectType="List"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

## Known Issues and Limitations

Salesforce Marketing Cloud Connector has some limitations, including when:

- Working with subclasses inside complex fields

- Trying to retrieve fields from a hierarchy

- Attempting to return an Automation object.

### Working with Subclasses Inside Complex Fields

Some objects in Salesforce Marketing Cloud have complex fields, such as the Recurrence field, which
belong to a base class. DataSense can only bring up fields specific to the base class.

To use additional fields that belong to a subclass of a base class, manually add the desired fields
to the Transform Message component. For Salesforce Marketing Cloud to know that you want to work
with a subclass and recognize the fields you added, you must also add a field called
concreteClassType of type String whose value is the name of the subclass.

See [Providing a Subclass as a Type to a Complex Field](#providing-subclass) for an example
detailing how to achieve this.

### Retrieve Operation Limitations

The Retrieve operation enables you to retrieve records in a SQL query-like fashion. When you use the
Retrieve operation, Salesforce Marketing Cloud prevents the retrieval of fields that are part of a
hierarchy. For example, the Subscriber object has a complex structure:

![Subscriber structure](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-as-subscriber-structure.png)

The API only allows you to query fields on the first level, such as `EmailAddress` or
`SubscriberKey`, but not fields such as `Attributes.Name`.

The `Retrieve` operation supports filters for querying the data. However the filters do not behave
like an SQL filter condition. For example, a clause such as `WHERE 1=1` works in SQL, but results in
an error in Salesforce Marketing Cloud because the API doesn’t support it. In this example, the
operand to the left of the equal sign must be a valid property of the Salesforce data extension
(SFDE).

When executing the request with the `WHERE 1=1` clause, the filter expects a property. It is
transformed into the following request:

`<Filter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleFilterPart"> <Property>1</Property> <SimpleOperator>equals</SimpleOperator> <Value>1</Value> </Filter>`.

The response is:

\`<OverallStatus>Error: The Filter Property '1' is not a retrievable property.</OverallStatus>\`.

When filtering the results of a query, only the following operators are supported in WHERE clauses:

<table><colgroup><col> <col></colgroup><thead><tr><th>Operator</th><th>Salesforce Marketing API equivalent</th></tr></thead><tbody><tr><td><p>=</p></td><td><p>equals</p></td></tr><tr><td><p>&lt;&gt;</p></td><td><p>notEquals</p></td></tr><tr><td><p>&gt;</p></td><td><p>greaterThan</p></td></tr><tr><td><p>&gt;=</p></td><td><p>greaterThanOrEqual</p></td></tr><tr><td><p>&lt;</p></td><td><p>lessThan</p></td></tr><tr><td><p>⇐</p></td><td><p>lessThanOrEqual</p></td></tr><tr><td><p>like</p></td><td><p>like</p></td></tr></tbody></table>

> [!IMPORTANT] This connector uses DSQL Query syntax instead of native Salesforce OQL and does not
> send the SQL query to the Salesforce server as is. Instead, the query is parsed and transformed
> into an XML object before it is sent. Because of this, any filters that are not included in the
> table above or any SQL syntax features, such as TOP(x), LIMIT, OFFSET, ALIAS, or JOINs, are
> unsupported. For more details, refer to the
> [Salesforce API Guide](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/retrieverequest.html#properties).

### Server Results Containing an Automation Object

Server results that contain an Automation object cause an exception to be thrown. When performing an
operation, such as Create or Delete, on an Automation object, the returned result contains the
structure of the Automation object you acted upon. The server also returns an additional field in
the Automation object called isPlatformObject that is not recognized by the WSDL.

To bypass this issue, make all operations that directly use an Automation object asynchronous. If an
operation is asynchronous, the immediate response of the operation is `Operation Queued`.

For more information, see [Asynchronous Operations](#asynchronous-operations).

## Common Use Cases

Use Salesforce Marketing Cloud Connector operations for the following common use cases:

- `Configure action` operation - Calls the Configure method with Create, Delete, or Update as the
  value of the Action parameter when connected to the Marketing Cloud API SOAP web service.

- `Create entities` operation - Creates new objects on the Marketing Cloud API web server.

- `Delete objects` operation - Deletes existing objects on the Marketing Cloud API web server.

- `Perform operation` - Calls the Perform method with the GetMaxCount, Start, or Stop as the value
  of the Action parameter when connected to the Marketing Cloud API SOAP web service.

- `Retrieve entities` operation - Retrieves objects from the Marketing Cloud API web server in a SQL
  query-like fashion.

- `Schedule start` operation - Calls the Schedule method with Start as the value of the Action
  parameter when connected to the Marketing Cloud API SOAP web service.

- `Update entities` operation - Updates existing objects on the Marketing Cloud API web server.

- `Upsert entities` operation - Creates objects on the Marketing Cloud API web server if the objects
  do not already exist, or updates existing objects on the server.

### Add a Proxy

To use a proxy server, set the following configuration properties on the **Advanced** tab of your
configuration:

![Proxy fields configuration](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-proxy.png)

### Providing a Subclass as a Type to a Complex Field

Suppose you want to schedule an existing Automation that sends emails to a subscriber list once per
minute. To do this, add a Schedule Reference to the connector through a flow variable:

![Schedule Start Automation configuration window](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-schedule-start-automation.png)

Use the **Recurrence** field in **ScheduleDefinition** to provide information such as how much time
to pass between sending emails. The **Recurrence** field is a complex field that has no structure.

To specify a MinutelyRecurrence instead of a Recurrence:

- Manually add the fields belonging to the MinutelyRecurrence class.

- Add an additional field called concreteClassType of type String whose value is the name of the
  subclass.

The mapping for the ScheduleDefinition looks like this in the example:

![Schedule definition](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-schedule-definition-transform-config.png)

This map has a field called `minuteInterval` that belongs to a subclass of Recurrence called
`MinutelyRecurrence`.

For the connector to use the MinutelyRecurrence object, you must also add the concreteClassType
field with `MinutelyRecurrence` as the value.

### Asynchronous Operations

Most operations are synchronous by default, meaning that the connector waits for the result of the
operation. For more details regarding the operations of the Marketing Cloud API, access the
Salesforce Marketing Cloud Methods documentation.

To specify that you want an operation to behave asynchronously, use the Options parameter for the
operation.

The following example creates a list of Automation objects to provide in the payload. Because the
result of any operation that works directly with Automation objects throws an exception caused by
the presence of an unknown field, the example uses the CreateOptions parameter to make the call
asynchronous. In this example, the CreateOptions value is provided in a variable called `vars`.

![Create options field with value specified](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-3-create-automation-config.png)

This mapping for CreateOptions in vars looks like this:

- The requestType field determines the type of call (SYNCHRONOUS or ASYNCHRONOUS).

- The conversationID field assigns a unique identifier to the asynchronous call.

You can group asynchronous calls together using the conversationID, callsInConversation, and
sequenceCode fields. For example, suppose you want to make five asynchronous calls to the server,
execute the calls together, and specify their execution order. To do this:

1.  Assign the same conversationID to each call.

2.  Set the callsInConversation field to 5.

3.  Use the sequenceCode field to order the calls.

The following example has a single call, so it passes a value of 1 to callsInConversation and
sequenceCode.

![Create options output](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-as-create-automation-options.png)

The Options parameter has more functionality than shown in this example. For more information, see
the Salesforce Marketing Cloud Objects documentation.

## See Also

- [Salesforce Get Started with the SOAP Web Services API](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/getting_started_developers_and_the_exacttarget_api.html)

- [Salesforce API Integration](https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/api-integration.html).

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8c973e20e7259a1f26a7c009e5404e119c459f6a2d9797f69be474ca61bbbed6 url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-examples.md -->

---
product: Salesforce Marketing Cloud Connector
version: 5.0
is-latest-version: true
---

# Salesforce Marketing Cloud Connector 5.0 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These examples show several Mule flows for Salesforce Marketing Cloud Connector:

- [Create a List](#create-list)

- [Retrieve a List](#retrieve-list)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    config-with-oauth.clientId=<clientId used to initialize the connection>
    config-with-oauth.clientSecret=<clientSecret used to authenticate the user>
    config-with-oauth.soapEndpoint=<SOAP endpoint address>
    config-with-oauth.authEndpoint=<Authentication endpoint>

    This may vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter
    `Salesforce Marketing Cloud`.

3.  Add **Salesforce Marketing Cloud Connector** to the **Selected modules** section and click
    **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Marketing Cloud** and click **OK**.

6.  Enter the values to configure either Basic Authentication or OAuth Client Credentials.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce
    Marketing Cloud API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select TLS Configuration > Edit inline.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Create a List

This Mule flow creates a list for storing subscribers.

> [!NOTE] The default value for the List type is `Public`, which makes the list visible to all
> subscribers. After creating the list, note the list ID to use it in other operations.

This example uses these operations:

- **HTTP Listener**  
  Accepts data from HTTP requests

- **Logger**  
  Shows the HTTP response from **HTTP Listener**

- **Transform Message**  
  Outputs the data in Java

  %dw 2.0 output application/java
  ---

  \[{

      ListClassification: payload.listClassification,
      ListName: payload.listName,
      "Type": payload.listType

  }\]

- **Create entities**  
  Creates new objects on the Salesforce Marketing Cloud API web server

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Object type</strong></p></td><td><div><div><p><code>List</code></p></div></div></td></tr><tr><td><p><strong>Connector Configuration</strong></p></td><td><div><div><p><code>Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config</code></p></div></div></td></tr><tr><td><p><strong>Api objects</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

- **Transform Message**  
  Outputs the data in JSON

  output application/json
  ---

  payload

![Studio flow for the Create List operation](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-create-list.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
      xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
  http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">

	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="2d500821-46be-4da2-a983-832ca1d829de" >
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config name="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" doc:name="Salesforce Marketing Cloud Sfdc marketing cloud config" doc:id="8c951adc-306a-4212-a33f-4be4b19a0076" >
		<sfdc-marketing-cloud:oauth-client-credentials-connection serviceUrl="${config-with-oauth-v2.serviceUrl}">
			<sfdc-marketing-cloud:oauth-client-credentials clientId="${config-with-oauth-v2.clientId}"
														   clientSecret="${config-with-oauth-v2.clientSecret}"
														   tokenUrl="${config-with-oauth-v2.tokenUrl}" />
		</sfdc-marketing-cloud:oauth-client-credentials-connection>
	</sfdc-marketing-cloud:config>

    <flow name="salesforce-marketing-cloud-oauth-demo-create-list-flow">
        <http:listener path="/create-list" doc:name="HTTP" config-ref="HTTP_Listener_config"/>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
        <ee:transform doc:name="Transform Message" doc:id="fab54a8d-4f2d-45cf-9496-9d407bf5837f" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[{

	ListClassification: payload.listClassification,
	ListName: payload.listName,
	"Type": payload.listType
}]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <sfdc-marketing-cloud:create config-ref="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" objectType="List" doc:name="Salesforce Marketing Cloud"/>
        <ee:transform doc:name="Transform Message" doc:id="a61ae2f3-0821-4884-9a4c-2306071c7ec8" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
    </flow>
</mule>
```

## Retrieve a List

This Mule flow retrieves the ID of a list to use in other operations.

This example uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests

- **Logger**  
  Shows the HTTP response from **HTTP Listener**

- **Transform Message**  
  Outputs the data in Java

  %dw 2.0 output application/java
  ---

  { query: "SELECT ID FROM List WHERE ListName ='" ++ payload.listName ++ "'" }

- **Retrieve entities**  
  Retrieves objects from the Salesforce Marketing Cloud API web server using an SQL query

  Enter these values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Connector Configuration</strong></p></td><td><div><div><p><code>Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config</code></p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p><code>#[payload.query]</code></p></div></div></td></tr></tbody></table>

- **Transform Message**  
  Outputs the data in JSON format

  %dw 2.0 output application/json
  ---

  payload

![Studio flow for the Retrieve List operation](/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/_images/salesforce-mktg-retrieve-list.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:sfdc-marketing-cloud="http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud"
      xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
  http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud http://www.mulesoft.org/schema/mule/sfdc-marketing-cloud/current/mule-sfdc-marketing-cloud.xsd">

	<configuration-properties file="mule-app.properties" />
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="651f3647-d4c9-4536-8d6b-bee43c422625" >
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

	<sfdc-marketing-cloud:config name="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config" doc:name="Salesforce Marketing Cloud Sfdc marketing cloud config" doc:id="7ef81352-ca1d-4134-bccb-b211a1951a60" >
		<sfdc-marketing-cloud:oauth-client-credentials-connection serviceUrl="${config-with-oauth-v2.serviceUrl}">
			<sfdc-marketing-cloud:oauth-client-credentials clientId="${config-with-oauth-v2.clientId}"
														   clientSecret="${config-with-oauth-v2.clientSecret}"
														   tokenUrl="${config-with-oauth-v2.tokenUrl}" />
		</sfdc-marketing-cloud:oauth-client-credentials-connection>
	</sfdc-marketing-cloud:config>

    <flow name="salesforce-marketing-cloud-oauth-demo-retrieve-list-flow">
        <http:listener path="/retrieve-list" doc:name="HTTP" config-ref="HTTP_Listener_config"/>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
        <ee:transform doc:name="Transform Message" doc:id="fe31d1a8-d189-4fbd-b96f-99c2eac092e1" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
{
	query: "SELECT ID FROM List WHERE ListName ='" ++ payload.listName ++ "'"
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <sfdc-marketing-cloud:retrieve doc:name="Salesforce Marketing Cloud" config-ref="Salesforce_Marketing_Cloud_Sfdc_marketing_cloud_config">
			<sfdc-marketing-cloud:query>#[payload.query]</sfdc-marketing-cloud:query>
		</sfdc-marketing-cloud:retrieve>
        <ee:transform doc:name="Transform Message" doc:id="d05834f2-3d96-4e95-bd3b-48057d4ca34e" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
    </flow>
</mule>
```

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=ac047c78d9a99185dde6b39bd07b9f6560e1f5512b6a4f95cf11fdc5e2b51152 url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-reference.md -->

---
product: Salesforce Marketing Cloud Connector
version: 5.0
is-latest-version: true
---

# Salesforce Marketing Cloud Connector 5.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud Connector) enables you
to connect to the Salesforce Marketing Cloud. This connector exposes convenient operations for
exploiting the capabilities of Salesforce Marketing Cloud.

## Configuration

Default Configuration for Salesforce Marketing Cloud Connector.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#Config_Basic">Basic Authentication</a></p></li><li><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></li></ul></div></div></td><td><div><div><p>Connection types for this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div><div><p><code>0</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read timeout time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID used to reference this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Basic Authentication Connection Type

Uses a username and a password for connection.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Service URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Proxy configuration</strong></p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy Configuration</a></p></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>WSDL file URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends <code>/etframework.wsdl</code> to the end.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to initialize the session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate the user.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth Client Credentials Connection Type

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

Uses a client ID, client secret, and token URL for connection.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Service URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Proxy configuration</strong></p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy Configuration</a></p></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>WSDL file URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends <code>/etframework.wsdl</code> to the end.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><div><div><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client ID, as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client secret, as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the service provider’s token endpoint.</p></div></div></td><td><div><div><p><code>https://{domain}.auth.marketingcloudapis.com/v2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Sources

- [On modified object](#ModifiedObjectListener)

- [On new object](#NewObjectListener)

### On modified object

`<sfdc-marketing-cloud:modified-object-listener>`

Listener for modified objects.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Since</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a date in the <code>yyyy-MM-dd HH:mm:ss</code> format, for example, <code>2017-03-17 16:30:40</code>, to retrieve the selected objects.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>Scheduling Strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

### On new object

`<sfdc-marketing-cloud:new-object-listener>`

Listener for new objects.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Since</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a date in the <code>yyyy-MM-dd HH:mm:ss</code> format, for example, <code>2017-03-17 16:30:40</code>, to retrieve the selected objects.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Primary Node Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scheduling Strategy</strong></p></td><td><div><div><p>Scheduling Strategy</p></div></div></td><td><div><div><p>Configures the scheduler that triggers the polling.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Redelivery Policy</strong></p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><div><div><p>Defines a policy for processing the redelivery of the same message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

## Operations

- [Configure action](#Configure)

- [Create entities](#Create)

- [Delete objects](#Delete)

- [Perform action](#Perform)

- [Retrieve entities](#Retrieve)

- [Schedule start action](#ScheduleStart)

- [Unauthorize](#Unauthorize)

- [Update entities](#Update)

- [Upsert entities](#Upsert)

### Configure action

`<sfdc-marketing-cloud:configure>`

Allows the configuration of actions.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Configurations</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more configurations to update.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Configure Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Action</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of action to perform.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object the action is performed on.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Create entities

`<sfdc-marketing-cloud:create>`

Creates one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to create.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>CreateOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Delete objects

`<sfdc-marketing-cloud:delete>`

Deletes one or more API objects from your organization’s data.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object to delete.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>DeleteOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Perform action

`<sfdc-marketing-cloud:perform>`

Performs an action on a determined type of object.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Definitions</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more definitions for the operation.</p></div></div></td><td><div><div><p><code>Service URL[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Perform Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Action</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of action to perform.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object the action is performed on.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Retrieve entities

`<sfdc-marketing-cloud:retrieve>`

Enables the retrieval of a single object type. This operation retrieves specified object properties
only. You can apply filters to ensure that only relevant results are returned. Only the properties
that have values for the object are returned. If an object that is requested does not exist, no
results are returned.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Query describing the objects that you want to retrieve.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>RetrieveOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>Non-Repeatable Iterable</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Schedule start action

`<sfdc-marketing-cloud:schedule-start>`

Schedules an action or an event to occur at a specific time.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object on which to do a schedule.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Interactions</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more interactions in the operation.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Definitions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Schedule definition used for the operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schedule Options</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Unauthorize

`<sfdc-marketing-cloud:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it is impossible to
execute any operation for that user without repeating the authorization dance.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

### Update entities

`<sfdc-marketing-cloud:update>`

Updates one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object to update.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>UpdateOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

### Upsert entities

`<sfdc-marketing-cloud:upsert>`

Upserts one or more API objects.

> [!IMPORTANT] When you map your objects to the input of this message processor, the objects must
> match the expected types of the objects in Salesforce Marketing Cloud. This operation performs
> **Create** with the `SaveAction` in the **CreateOptions** for the fields set to `UPDATE_ADD`.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Object Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of API object to upsert.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Api Objects</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>Array of one or more API objects.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>UpsertOptions</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Options for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration used to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amount</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long the consumer waits for a response before timing out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Amount</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type</p></td><td><p>Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#Config)

#### Throws

- SFDC-MARKETING-CLOUD:CONNECTIVITY

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

- SFDC-MARKETING-CLOUD:PARSING

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

## Object Types

- [Crl File](#CrlFile)

- [Custom Ocsp Responder](#CustomOcspResponder)

- [Error Mapping](#ErrorMapping)

- [Expiration Policy](#ExpirationPolicy)

- [Key Store](#KeyStore)

- [Proxy Configuration](#ProxyConfiguration)

- [Reconnect](#reconnect)

- [Reconnect Forever](#reconnect-forever)

- [Reconnection](#Reconnection)

- [Redelivery Policy](#RedeliveryPolicy)

- [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier)

- [Repeatable File Store Iterable](#RepeatableFileStoreIterable)

- [Repeatable In Memory Iterable](#RepeatableInMemoryIterable)

- [Standard Revocation Check](#StandardRevocationCheck)

- [TLS](#Tls)

- [Trust Store](#TrustStore)

### Crl File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

Configures the error mapping of the connector.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div><div><p>Source of the error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Target of the error.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Proxy Configuration

Configures a proxy for outbound connections.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname or IP address of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of hosts that the proxy must not be used against.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Ntlm Domain</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Domain to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a <code>REDELIVERY_EXHAUSTED</code> error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>One or more expressions that determine if a message was redelivered. This property can be set only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was
redelivered.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule uses a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. You can set this property only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

Configures the repeatable file store iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

Configures the repeatable in memory iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the <strong>Buffer Size Increment</strong> attribute, with an upper limit of <strong>Max In Memory Size</strong>. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand. A <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full.</p></div></div></td><td><div><div><p><code>100</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory to use. If more than that is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=2a50bf0309e212ca99f08a7601337f0154f397bf11aa93df4a9791f095f2c9bb url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-troubleshooting.md -->

---
product: Salesforce Marketing Cloud Connector
version: 4.1
---

# Troubleshooting Salesforce Marketing Cloud Connector 4.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud
Connector), become familiar with the information about interpreting commonly thrown exception
messages.

## Enable SSL Logging

Enable SSL logs to investigate an issue related to TLS communications.

Set your SSL log level depending on your required level of detail:

1.  Enable only SSL log details:

    `javax.net.debug=ssl`

2.  Enable only handshaking details. (The handshake protocol is a series of messages exchanged over
    the record protocol.)

    `javax.net.debug=ssl:handshake`

3.  Enable handshaking details and SSL details at the same time:

    `javax.net.debug=ssl, handshake`

4.  Enable the dumping of all details and traffic data:

    `javax.net.debug=all`

    > [!NOTE] This option is very verbose and under normal circumstances is not necessary.

> [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable
> SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL
> logging produces a significant amount of log messages and can inundate your log file if it is left
> enabled and unattended.

To enable SSL logs:

Set the debug parameter as an argument in the runtime configuration for the application.

1.  In Studio, right-click on the project and select **Run > Run Configurations**.

2.  Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section.

## Enable Verbose Exception Logging

Enable verbose exception logs to show a complete stack trace of the error instead of the default
truncated output:

1.  In Studio, right-click on the project and select **Run > Run Configurations**.

2.  Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the
    `mule.verbose.exceptions` property. For example:

    `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true`

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with Salesforce Marketing Cloud
Connector is failing, temporarily enable verbose logging for the connector.

Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule
application’s performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="com.mulesoft.connectors.salesforce.marketing" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Commonly Thrown Exceptions

Here is a list of commonly thrown exception messages and how to interpret them:

- SFDC-MARKETING-CLOUD:CONNECTIVITY

  Either a connection could not be established or there is a connectivity error.

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

  The external service responds with an error.

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

  The provided input data for an operation is not valid.

- SFDC-MARKETING-CLOUD:PARSING

  An error occurs when parsing the input or output data to XML.

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

  The maximum number of retries for the operation is reached.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Marketing Cloud Connector Reference](https://docs.mulesoft.com/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=661fdf69ec4fabdb9af0779dce56f32cbd0307f967d7c460676fe29c2c886424 url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-troubleshooting.md -->

---
product: Salesforce Marketing Cloud Connector
version: 5.0
is-latest-version: true
---

# Troubleshooting Salesforce Marketing Cloud Connector 5.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud
Connector), become familiar with the information about interpreting commonly thrown exception
messages.

## Enable SSL Logging

Enable SSL logs to investigate an issue related to TLS communications.

Set your SSL log level depending on your required level of detail:

1.  Enable only SSL log details:

    `javax.net.debug=ssl`

2.  Enable only handshaking details. (The handshake protocol is a series of messages exchanged over
    the record protocol.)

    `javax.net.debug=ssl:handshake`

3.  Enable handshaking details and SSL details at the same time:

    `javax.net.debug=ssl, handshake`

4.  Enable the dumping of all details and traffic data:

    `javax.net.debug=all`

    > [!NOTE] This option is very verbose and under normal circumstances is not necessary.

> [!WARNING] SSL logging results in a performance impact for HTTPS or other TLS connections. Enable
> SSL logging only to troubleshoot a specific issue and do not enable it for extended periods. SSL
> logging produces a significant amount of log messages and can inundate your log file if it is left
> enabled and unattended.

To enable SSL logs:

Set the debug parameter as an argument in the runtime configuration for the application.

1.  In Studio, right-click on the project and select **Run > Run Configurations**.

2.  Go to the **Arguments** tab and add `-M-Djavax.net.debug=ssl` in the **VM arguments** section.

## Enable Verbose Exception Logging

Enable verbose exception logs to show a complete stack trace of the error instead of the default
truncated output:

1.  In Studio, right-click on the project and select **Run > Run Configurations**.

2.  Go to the **Arguments** tab and append the arguments in the **VM arguments** section to add the
    `mule.verbose.exceptions` property. For example:

    `-XX:PermSize=128M -XX:MaxPermSize=256M -Dmule.verbose.exceptions=true`

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with Salesforce Marketing Cloud
Connector is failing, temporarily enable verbose logging for the connector.

Remember to always disable enhanced verbosity after troubleshooting, because it can affect your Mule
application’s performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="com.mulesoft.connectors.salesforce.marketing" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Commonly Thrown Exceptions

Here is a list of commonly thrown exception messages and how to interpret them:

- SFDC-MARKETING-CLOUD:CONNECTIVITY

  Either a connection could not be established or there is a connectivity error.

- SFDC-MARKETING-CLOUD:ERROR\_RESPONSE

  The external service responds with an error.

- SFDC-MARKETING-CLOUD:INVALID\_INPUT

  The provided input data for an operation is not valid.

- SFDC-MARKETING-CLOUD:PARSING

  An error occurs when parsing the input or output data to XML.

- SFDC-MARKETING-CLOUD:RETRY\_EXHAUSTED

  The maximum number of retries for the operation is reached.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Marketing Cloud Connector Reference](https://docs.mulesoft.com/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=2a11cc42b10d52ba2d8566f27c1995b00f40b35b5993c9c97ada638a36e0ea45 url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/4.1/salesforce-mktg-connector-upgrade-migrate.md -->

---
product: Salesforce Marketing Cloud Connector
version: 4.1
---

# Upgrading and Migrating Salesforce Marketing Cloud Connector to 4.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud Connector) to
version 4.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>3.x</p></div></div></td><td><div><div><p>4.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

- The connector now supports multiple child organizations by specifying the **Account Id** field.

- The `SFDC-MARKETING-CLOUD:THROTTLED` error is removed.

## Upgrade Prerequisites

Before you perform the upgrade, you must:

1.  Create a backup of your files, data, and configuration in case you must restore to the previous
    version.

2.  Install Salesforce Marketing Cloud Connector 4.x.x.

## Upgrade Steps

Follow these steps to perform the upgrade from Salesforce Marketing Cloud Connector 3.x.x to
Salesforce Marketing Cloud Connector 4.x.x:

1.  In Anypoint Studio, create a Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange**.

3.  In the **Add Dependencies to Project** window, enter `Salesforce Marketing Cloud` in the search
    field.

4.  In the **Available modules** section, select **Salesforce Marketing Cloud Connector** and click
    **Add**.

5.  Click **Finish**.

6.  Verify that the `mule-sfdc-marketing-cloud-connector` dependency version is `4.x.x` in the
    `pom.xml` file, in which the first `x` is the minor release number and the second `x` is the
    patch release number.

Studio upgrades the connector automatically.

## Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Check the project `pom.xml` file and verify that there are no problems.

3.  Test the connection and verify that the operations work.

## Troubleshooting

If there are problems with caching the parameters or caching the metadata, try restarting Studio.

## Revert the Upgrade

If it is necessary to revert to the previous version of Salesforce Marketing Cloud Connector, change
the `mule-sfdc-marketing-cloud-connector` dependency version `4.x.x` in the project’s `pom.xml` file
to the previous version.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=43bf2624d5f6296a1a161ad222fa3158d5c5a0adef1be87294728e77475061bf url=/mulesoft/current/en-us/salesforce-marketing-cloud-connector/latest/salesforce-mktg-connector-upgrade-migrate.md -->

---
product: Salesforce Marketing Cloud Connector
version: 5.0
is-latest-version: true
---

# Upgrading and Migrating Salesforce Marketing Cloud Connector to 5.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Anypoint Connector for Salesforce Marketing Cloud (Salesforce Marketing Cloud Connector) to
version 5.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>4.x</p></div></div></td><td><div><div><p>5.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

- This connector is now compatible with Java 17 only.

- These libraries are upgraded to address reported security vulnerabilities:

  - The `springframework` library is upgraded to version 6.2.18.

  - The `jackson-databind` and `jackson-dataformat-xml` libraries are upgraded to version 2.21.3.

  - The `cxf-core` library is upgraded to 4.2.0.

  - The `woodstox-core` library is upgraded to version 7.2.0.

  - The `stax2-api` library is upgraded to version 4.3.0.

  - The `cryptacular` library is upgraded to version 1.3.0.

  - The `dom4j` library is upgraded to version 2.2.0.

  - The `commons-io` library is upgraded to version 2.22.0.

  - The `commons.lang3` library is upgraded to version 3.20.0.

  - The `commons-codec` library is upgraded to version 1.22.0.

  - The `commons-beanutils` library is upgraded to version 1.11.0.

  - The `commons-text` library is upgraded to version 1.14.0.

  - The `kotlin-stdlib` library is upgraded to version 2.1.21.

  - The `xmlsec` library is upgraded to version 4.0.4.

  - The `guava` library is upgraded to version 33.6.0-jre.

  - The `jakarta.xml.bind-api` library is upgraded to version 4.0.2.

  - The `jaxb-runtime` library is upgraded to version 4.0.5.

  - The `jakarta.xml.ws-api` library is upgraded to version 4.0.2.

  - The `jakarta.jws-api` library is upgraded to version 3.0.0.

  - The `jakarta.xml.soap-api` library is upgraded to version 3.0.2.

  - The `jakarta.activation-api` library is upgraded to version 2.1.3.

  - The `jackson-module-jaxb-annotations` library is replaced by the
    `jackson-module-jakarta-xmlbind-annotations` library.

- The FuelSDK dependency is removed. Core connector operations are now migrated to localized,
  compile-time generated classes to eliminate external classpath and transitive library conflicts in
  your Mule applications.

## Upgrade Prerequisites

Before you perform the upgrade, you must:

1.  Create a backup of your files, data, and configuration in case you must restore to the previous
    version.

2.  Install Salesforce Marketing Cloud Connector 5.x.x.

## Upgrade Steps

Follow these steps to perform the upgrade from Salesforce Marketing Cloud Connector 4.x.x to
Salesforce Marketing Cloud Connector 5.x.x:

1.  In Anypoint Studio, create a Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange**.

3.  In the **Add Dependencies to Project** window, enter `Salesforce Marketing Cloud` in the search
    field.

4.  In the **Available modules** section, select **Salesforce Marketing Cloud Connector** and click
    **Add**.

5.  Click **Finish**.

6.  Verify that the `mule-sfdc-marketing-cloud-connector` dependency version is `5.x.x` in the
    `pom.xml` file, in which the first `x` is the minor release number and the second `x` is the
    patch release number.

Studio upgrades the connector automatically.

## Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Check the project `pom.xml` file and verify that there are no problems.

3.  Test the connection and verify that the operations work.

## Troubleshooting

If there are problems with caching the parameters or caching the metadata, try restarting Studio.

## Revert the Upgrade

If it is necessary to revert to the previous version of Salesforce Marketing Cloud Connector, change
the `mule-sfdc-marketing-cloud-connector` dependency version `5.x.x` in the project’s `pom.xml` file
to the previous version.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)