# mulesoft Salesforce Marketing Cloud REST Connector - Full Documentation --- product: Salesforce Marketing Cloud REST Connector version: 1.2 is-latest-version: true --- # Salesforce Marketing Cloud REST Connector 1.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Marketing Cloud REST (Salesforce Marketing Cloud REST Connector) enables you to integrate with the Salesforce Marketing Cloud marketing platform. This connector exposes operations provided by the Salesforce Marketing Cloud REST API. For information about compatibility and fixed issues, refer to the Salesforce Marketing Cloud REST Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Marketing Cloud REST API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have: - Credentials to access the Salesforce Marketing Cloud REST target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder ## Connection Types Salesforce Marketing Cloud REST connections use the OAuth Client Credentials authentication type, which enables a client to use its own credentials. ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Marketing Cloud REST Connector Reference](https://docs.mulesoft.com/salesforce-marketing-cloud-rest-connector/latest/salesforce-marketing-cloud-rest-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Marketing Cloud REST Connector version: 1.2 is-latest-version: true --- # Salesforce Marketing Cloud REST Connector 1.2 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config #### Parameters

Name	Type	Description	Default Value	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.		x
Connection	OAuth Client Credentials	Connection types for this configuration.		x
Name	String	ID used to reference this configuration.		x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
Read Timeout	Number	Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.	60
Read Timeout Time unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Read Timeout field.	SECONDS

#### Connection Types ##### OAuth Client Credentials 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). ###### Parameters

Name	Type	Description	Default Value	Required
Service URL	String	Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints are derived from this base URL.		x
Proxy configuration	Proxy	Proxy configuration for the connector.
Connection Timeout	Number	Socket connection timeout value.
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Connection Timeout field.	SECONDS
TLS configuration	TLS	If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.
Reconnection	Reconnection	What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: `true` Allow the deployment to fail. `false` Ignore the results of the connectivity test.
Client Id	String	OAuth client ID as registered with the service provider.		x
Client Secret	String	OAuth client secret as registered with the service provider.		x
Token Url	String	Service provider’s token endpoint URL.	`https://{domain}.auth.marketingcloudapis.com/v1/token`
Scopes	String	OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.
Object Store	String	Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

## Supported Operations - [Create Asset](#CreateAsset) - [Create Email Send Definition](#CreateEmailSendDefinition) - [Create Event Definition](#CreateEventDefinition) - [Create Keyword](#CreateKeyword) - [Create Sms Send Definition](#CreateSmsSendDefinition) - [Delete Asset](#DeleteAsset) - [Delete Email Send Definition](#DeleteEmailSendDefinition) - [Delete Event Definition](#DeleteEventDefinition) - [Delete Keyword By Id](#DeleteKeywordById) - [Delete Keyword By Long Code](#DeleteKeywordByLongCode) - [Delete Keyword By Short Code](#DeleteKeywordByShortCode) - [Delete Sms Send Definition](#DeleteSmsSendDefinition) - [Get Event Definition](#GetEventDefinition) - [Send Email Message To Single Recipient](#SendEmailMessageToSingleRecipient) - [Send Email Message To Multiple Recipients](#SendEmailMessageToMultipleRecipients) - [Send Email Message Using Triggered Send Definition](#SendEmailMessageUsingTriggeredSendDefinition) - [Send Sms Message To Single Recipient](#SendSmsMessageToSingleRecipient) - [Send Sms Message To Multiple Recipients](#SendSmsMessageToMultipleRecipients) - [Trigger Event](#TriggerEvent) - [Unauthorize](#Unauthorize) - [Update Event Definition](#UpdateEventDefinition) ## Create Asset `` Creates a draft of a new asset in either JSON or MIME format. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Asset Type	Enumeration, one of: TEXT_ONLY_EMAIL HTML_EMAIL TEMPLATE_BASED_EMAIL	Asset type.	TEXT_ONLY_EMAIL
Asset	Any	Asset to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Binary
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Email Send Definition	Any	Email send definition to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

### For Configurations - [Config](#Config) ### Throws - SFDC-MARKETING-CLOUD-REST:BAD\_REQUEST - SFDC-MARKETING-CLOUD-REST:CONFLICT - SFDC-MARKETING-CLOUD-REST:CONNECTIVITY - SFDC-MARKETING-CLOUD-REST:FORBIDDEN - SFDC-MARKETING-CLOUD-REST:INVALID\_CONNECTION - SFDC-MARKETING-CLOUD-REST:INVALID\_CREDENTIALS - SFDC-MARKETING-CLOUD-REST:NOT\_FOUND - SFDC-MARKETING-CLOUD-REST:RETRY\_EXHAUSTED - SFDC-MARKETING-CLOUD-REST:SERVER\_ERROR - SFDC-MARKETING-CLOUD-REST:TIMEOUT ## Create Event Definition `` Creates an event definition (name and data schema for an event) and defines an event definition key. The resource uses this key when firing an event to send it to the appropriate journey. Typically, marketers create the event definition in the Journey Builder UI. Use this resource instead if you’re using a custom application for Journey Builder functionality. To call this resource, assign your API Integration the `Automation > Journeys/Interactions > Read` scope. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Event Definition	Any	Email send definition to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect 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.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Keyword	Any	Keyword to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Sms Send Definition	Any	SMS send definition to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Id	Number	ID of the asset to delete.		x
Is Cdn Delete	Boolean	Permanently deletes the file and its URL in the CDN when the associated file is deleted in Content Builder. A value of `1` permanently deletes the file. An unspecified value or a value of `0` does not permanently delete the file.	false
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### For Configurations - [Config](#Config) ### Throws - SFDC-MARKETING-CLOUD-REST:BAD\_REQUEST - SFDC-MARKETING-CLOUD-REST:CONFLICT - SFDC-MARKETING-CLOUD-REST:CONNECTIVITY - SFDC-MARKETING-CLOUD-REST:FORBIDDEN - SFDC-MARKETING-CLOUD-REST:INVALID\_CONNECTION - SFDC-MARKETING-CLOUD-REST:INVALID\_CREDENTIALS - SFDC-MARKETING-CLOUD-REST:NOT\_FOUND - SFDC-MARKETING-CLOUD-REST:RETRY\_EXHAUSTED - SFDC-MARKETING-CLOUD-REST:SERVER\_ERROR - SFDC-MARKETING-CLOUD-REST:TIMEOUT ## Delete Email Send Definition `` Deletes a message definition. You cannot restore a deleted definition. The deleted definition is archived, and the response provides a delete location of the definition key for reference. You can reuse a deleted definition key because the information associated with the deleted definition key is copied to a new unique identifier. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Definition Key	String	Definition key to delete.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Definition Option	DefinitionOption	Definition key to delete.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

### Output

Type	Binary
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Keyword ID	String	Keyword ID to delete.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Keyword	String	Keyword to delete.		x
Long code	String	Long code of the keyword to delete.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Keyword	String	Keyword to delete.		x
Short code	String	Short code of the keyword to delete.		x
Country code	String	Country code of the keyword to delete.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

### For Configurations - [Config](#Config) ### Throws - SFDC-MARKETING-CLOUD-REST:BAD\_REQUEST - SFDC-MARKETING-CLOUD-REST:CONFLICT - SFDC-MARKETING-CLOUD-REST:CONNECTIVITY - SFDC-MARKETING-CLOUD-REST:FORBIDDEN - SFDC-MARKETING-CLOUD-REST:INVALID\_CONNECTION - SFDC-MARKETING-CLOUD-REST:INVALID\_CREDENTIALS - SFDC-MARKETING-CLOUD-REST:NOT\_FOUND - SFDC-MARKETING-CLOUD-REST:RETRY\_EXHAUSTED - SFDC-MARKETING-CLOUD-REST:SERVER\_ERROR - SFDC-MARKETING-CLOUD-REST:TIMEOUT ## Delete Sms Send Definition `` Deletes a message definition. You cannot restore a deleted definition. The deleted definition is archived, and the response provides a delete location of the definition key for reference. You can reuse a deleted definition key because the information associated with the deleted definition key is copied to a new unique identifier. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Definition Key	String	Definition key to delete.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour.
Event Definition Id	String	The ID of the event definition expressed in the form of a GUID (UUID). Required if not using a key.
Event Definition Key	String	The key of the event definition. Required if not using an ID.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect 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.

### Output

Type	Any
Attributes Type	Object

### For Configurations - [Config](#Config) ### Throws - SFDC-MARKETING-CLOUD-REST:BAD\_REQUEST - SFDC-MARKETING-CLOUD-REST:CONFLICT - SFDC-MARKETING-CLOUD-REST:CONNECTIVITY - SFDC-MARKETING-CLOUD-REST:FORBIDDEN - SFDC-MARKETING-CLOUD-REST:INVALID\_CONNECTION - SFDC-MARKETING-CLOUD-REST:INVALID\_CREDENTIALS - SFDC-MARKETING-CLOUD-REST:NOT\_FOUND - SFDC-MARKETING-CLOUD-REST:RETRY\_EXHAUSTED - SFDC-MARKETING-CLOUD-REST:SERVER\_ERROR - SFDC-MARKETING-CLOUD-REST:TIMEOUT ## Send Email Message To Multiple Recipients `` Sends a message to multiple recipients using a send definition. You can provide a messageKey in the request; otherwise, the messageKey is automatically generated in the response. The limit is 2000 recipients per request. If you send attributes with the recipients, we recommend no more than 500 recipients per request. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Send Email Request Body	Any	Email send definition to create.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Message Key	String	Unique identifier used to track the message status. Can be automatically created when you create a message or can be provided as part of the request. Can be up to 100 characters, and there are no restricted characters. Each recipient in a request must have a unique Message Key. If you use a duplicate Message Key in the same send request, the message is rejected.		x
Email Request Body	Any	Content of the message to send.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Triggered Send Email Body	Any	Content of the message to send.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour
Id	String	The ID of the event definition expressed in the form of a GUID (UUID). Required if not using a key.
Key	String	The key of the event definition. Required if not using an ID.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect 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.

### Output

Type	Any
Attributes Type	Object

### For Configurations - [Config](#Config) ### Throws - SFDC-MARKETING-CLOUD-REST:BAD\_REQUEST - SFDC-MARKETING-CLOUD-REST:CONFLICT - SFDC-MARKETING-CLOUD-REST:CONNECTIVITY - SFDC-MARKETING-CLOUD-REST:FORBIDDEN - SFDC-MARKETING-CLOUD-REST:INVALID\_CONNECTION - SFDC-MARKETING-CLOUD-REST:INVALID\_CREDENTIALS - SFDC-MARKETING-CLOUD-REST:NOT\_FOUND - SFDC-MARKETING-CLOUD-REST:RETRY\_EXHAUSTED - SFDC-MARKETING-CLOUD-REST:SERVER\_ERROR - SFDC-MARKETING-CLOUD-REST:TIMEOUT ## Send Sms Message To Multiple Recipients `` Sends a message to multiple recipients using a send definition. You can provide a messageKey in the request; otherwise, the messageKey is automatically generated in the response. The limit is 2000 recipients per request. If you send attributes with the recipients, we recommend no more than 500 recipients per request. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Request Body	Any	Content of the message to send.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Message Key	String	Unique identifier used to track the message status. Can be automatically created when you create a message or can be provided as part of the request. Can be up to 100 characters, and there are no restricted characters. Each recipient in a request must have a unique Message Key. If you use a duplicate Message Key in the same send request, the message is rejected.		x
Request Body	Any	Content of the message to send.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Trigger Event Request Body	Any	The content of the message to send.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour,
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect 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.

### Output

Type	Any
Attributes Type	Object

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x

### For Configurations - [Config](#Config) ## Update Event Definition `` Updates an event definition by ID or key. Once an event definition is created, only a few properties can be updated. To call this resource, assign your API Integration the `Automation | Interactions | Read` scope. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Definition Option	DefinitionOption	Definition key to delete.		x
Update Event Definition Body	Any	Event definition to update.	#[payload]
Read Timeout	Number	Read timeout value. Overrides the read timeout values defined in the connector configuration.
Read Timeout Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit value for the Read Timeout field.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	#[payload]
Reconnection Strategy	Reconnect 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.

### Output

Type	Any
Attributes Type	Object

Field	Type	Description	Required
Host	String	Hostname or IP address of the proxy server.	x
Port	Number	Port of the proxy server.	x
Username	String	Username to authenticate against the proxy server.
Password	String	Password to authenticate against the proxy server.
Non Proxy Hosts	Array of String	List of hosts against which the proxy must not be used.
Ntlm Domain	String	Domain to authenticate against the proxy.

### TLS Configures TLS to provide secure communications for the Mule app.

Field	Type	Description
Enabled Protocols	String	Comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	Comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS truststore.
Key Store	Keystore	Configures the TLS keystore.
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File	Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.

Field	Type	Description
Path	String	Path to the truststore. Mule resolves the path relative to the current classpath and file system.
Password	String	Password used to protect the truststore.
Type	String	Type of truststore.
Algorithm	String	Encryption algorithm that the truststore uses.
Insecure	Boolean	If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.

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

Field	Type	Description
Path	String	Path to the keystore. Mule resolves the path relative to the current classpath and file system.
Type	String	Type of keystore.
Alias	String	Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.
Key Password	String	Password used to protect the private key.
Password	String	Password used to protect the keystore.
Algorithm	String	Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Which elements to verify in the certificate chain: `true` Verify only the last element in the certificate chain. `false` Verify all elements in the certificate chain.
Prefer Crls	Boolean	How to check certificate validity: `true` Check the Certification Revocation List (CRL) for certificate validity. `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
No Fallback	Boolean	Whether to use the secondary method to check certificate validity: `true` Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. `false` Do not use the secondary method to check certificate validity.
Soft Fail	Boolean	What to do if the revocation server can’t be reached or is busy: `true` Avoid verification failure. `false` Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.

Field	Type	Description	Default Value	Required
Url	String	URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

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

Field	Type	Description	Default Value	Required
Path	String	Path to the CRL file.

### Definition Option

Field	Type	Description	Default Value	Required
Id	String	The ID of the event definition expressed as a GUID (UUID). Required if not using a key.
Key	String	The key of the event definition. Required if not using an ID.

### Reconnection Configures a reconnection strategy for an operation.

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: `true` Allow the deployment to fail. `false` Ignore the results of the connectivity test.
Reconnection Strategy	Reconnect Reconnect Forever	Reconnection strategy to use.

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

Field	Type	Description
Frequency	Number	How often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If `false`, the reconnection strategy runs in a separate, non-blocking thread.
Count	Number	How many reconnection attempts the Mule app can make.

### 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.

Field	Type	Description	Default Value	Required
Frequency	Number	How often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If `false`, the reconnection strategy runs in a separate, non-blocking thread.

### Expiration Policy Configures an expiration policy strategy.

Field	Type	Description	Default Value	Required
Max Idle Time	Number	Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field	Type	Description
Initial Buffer Size	Number	Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.
Buffer Size Increment	Number	Amount by which the buffer size expands if it exceeds its initial size. Setting a value of `0` or lower specifies that the buffer can’t expand.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field	Type	Description	Default Value	Required
In Memory Size	Number	Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance: Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory. Configure a smaller buffer size to decrease memory load at the expense of response time.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the In Memory Size field.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)