Salesforce Marketing Cloud REST Connector 1.2 Reference | MuleSoft Documentation
# Salesforce Marketing Cloud REST Connector 1.2 Reference
## Configurations
### Config
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
Connection |  OAuth Client Credentials | Connection types for this configuration.  
ID used to reference this configuration.  
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 | Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.  
Read Timeout Time unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Read Timeout** field.  
#### 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 or Configuring OAuth 2.0 for Connectors on CloudHub.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Service URL | Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints are derived from this base URL.  
Proxy configuration | Proxy configuration for the connector.  
Connection Timeout | Socket connection timeout value.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Connection Timeout** field.  
TLS configuration | If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.  
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 | OAuth client ID as registered with the service provider.  
Client Secret | OAuth client secret as registered with the service provider.  
Token Url | Service provider’s token endpoint URL. | `https://{domain}.auth.marketingcloudapis.com/v1/token`  
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.  
Object Store | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
## Supported Operations
  *   * Create Email Send Definition
  * Create Event Definition
  * Create Keyword
  * Create Sms Send Definition
  *   * Delete Email Send Definition
  * Delete Event Definition
  * Delete Keyword By Id
  * Delete Keyword By Long Code
  * Delete Keyword By Short Code
  * Delete Sms Send Definition
  * Get Event Definition
  * Send Email Message To Single Recipient
  * Send Email Message To Multiple Recipients
  * Send Email Message Using Triggered Send Definition
  * Send Sms Message To Single Recipient
  * Send Sms Message To Multiple Recipients
  *   *   * Update Event Definition


## Create Asset
`<sfdc-marketing-cloud-rest:create-asset>`
Creates a draft of a new asset in either JSON or MIME format.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Asset Type |  Enumeration, one of:
  * TEXT_ONLY_EMAIL
  * HTML_EMAIL
  * TEMPLATE_BASED_EMAIL

| Asset type. | TEXT_ONLY_EMAIL  
Asset to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Email Send Definition
`<sfdc-marketing-cloud-rest:create-email-send-definition>`
Creates a long-living send definition object that references the email template, subscriber list, sending options, journey, and metadata.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Email Send Definition | Email send definition to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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
`<sfdc-marketing-cloud-rest: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 | The name of the configuration to use.  
Event Definition | Email send definition to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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 Keyword
`<sfdc-marketing-cloud-rest:create-keyword>`
Creates a keyword on an account.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Keyword to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Sms Send Definition
`<sfdc-marketing-cloud-rest:create-sms-send-definition>`
Creates an SMS send definition.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Sms Send Definition | SMS send definition to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Asset
`<sfdc-marketing-cloud-rest:delete-asset>`
Deletes an asset.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
ID of the asset to delete.  
Is Cdn Delete | Permanently deletes the file and its URL in Akamai 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.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### For Configurations
### 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
`<sfdc-marketing-cloud-rest: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 | Name of the configuration to use.  
Definition Key | Definition key to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Event Definition
`<sfdc-marketing-cloud-rest:delete-event-definition>`
Deletes an individual event definition by ID or key.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Definition Option |  DefinitionOption | Definition key to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type  
---  
### For Configurations
### 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 Keyword By Id
`<sfdc-marketing-cloud-rest:delete-keyword-by-id>`
Deletes a keyword from an account.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Keyword ID | Keyword ID to delete. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Keyword By Long Code
`<sfdc-marketing-cloud-rest:delete-keyword-by-long-code>`
Deletes a keyword from an account.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Keyword to delete.  
Long code | Long code of the keyword to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Keyword By Short Code
`<sfdc-marketing-cloud-rest:delete-keyword-by-short-code>`
Deletes a keyword from an account.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Keyword to delete.  
Short code | Short code of the keyword to delete.  
Country code | Country code of the keyword to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
## Delete Keyword By Short Code
`<sfdc-marketing-cloud-rest:delete-keyword-by-short-code>`
Deletes a keyword from an account.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Keyword to delete.  
Short code | Short code of the keyword to delete.  
Country code | Country code of the keyword to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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
`<sfdc-marketing-cloud-rest: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 | Name of the configuration to use.  
Definition Key | Definition key to delete.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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


## Get Event Definition
`<sfdc-marketing-cloud-rest:get-event-definition>`
Retrieves an individual event definition by ID or key.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | The ID of the event definition expressed in the form of a GUID (UUID). Required if not using a key.  
Event Definition Key | The key of the event definition. Required if not using an ID.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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
`<sfdc-marketing-cloud-rest: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 | The name of the configuration to use.  
Send Email Request Body | Email send definition to create. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type  
---  
### For Configurations
### 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
| Configure if repeatable streams should be used and their behaviour.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type  
---  
### For Configurations
### 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 Single Recipient
`<sfdc-marketing-cloud-rest:send-email-message-to-single-recipient>`
Sends a message to a single recipient via a send definition using a **Message Key** path parameter.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Message Key | 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.  
Email Request Body | Content of the message to send. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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 Using Triggered Send Definition
`<sfdc-marketing-cloud-rest:send-email-message-using-triggered-send-definition>`
Sends transactional email using Marketing Cloud’s triggered send functionality.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Triggered Send Email Body | Content of the message to send. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | The name of the configuration to be used to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure if repeatable streams should be used and their behaviour  
The ID of the event definition expressed in the form of a GUID (UUID). Required if not using a key.  
The key of the event definition. Required if not using an ID.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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
`<sfdc-marketing-cloud-rest: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 | The name of the configuration to use.  
Request Body | Content of the message to send. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type**  
---  
### For Configurations
### 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
| Configure if repeatable streams should be used and their behaviour  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
**Attributes Type**  
---  
### For Configurations
### 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 Single Recipient
`<sfdc-marketing-cloud-rest:send-sms-message-to-single-recipient>`
Sends a message to a single recipient via a send definition using a **Message Key** path parameter.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Message Key | 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.  
Request Body | Content of the message to send. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors.  
### Output
Attributes Type  
---  
### For Configurations
### 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


## Trigger Event
`<sfdc-marketing-cloud-rest:trigger-event>`
Fires the entry event that initiates the journey. If you use UTF-8 characters in a payload for the Rest API, change the Content-Type header to: `application/json; charset=UTF-8`.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Trigger Event Request Body | The content of the message to send. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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


## Unauthorize
`<sfdc-marketing-cloud-rest: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 doing the authorization dance again.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
### For Configurations
## Update Event Definition
`<sfdc-marketing-cloud-rest: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 | The name of the configuration to use.  
Definition Option |  DefinitionOption | Definition key to delete.  
Update Event Definition Body | Event definition to update. | #[payload]  
Read Timeout | 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

| Time unit value for the **Read Timeout** field.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
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 | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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
| Configure if repeatable streams should be used and their behaviour.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field. | #[payload]  
Reconnection Strategy | 
  *   * 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
Attributes Type  
---  
### For Configurations
### 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


## Types
### Proxy
Configures a proxy for outbound connections.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Hostname or IP address of the proxy server.  
Port of the proxy server.  
Username to authenticate against the proxy server.  
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** |  Domain to authenticate against the proxy.  
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  Comma-separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  Comma-separated list of cipher suites enabled for this context.  
**Trust Store** |  Configures the TLS truststore.  
Configures the TLS keystore.  
**Revocation Check** | 
  * Standard Revocation Check
  * Custom OCSP Responder

|  Configures a revocation checking mechanism.  
### Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the truststore. Mule resolves the path relative to the current classpath and file system.  
Password used to protect the truststore.  
Type of truststore.  
Encryption algorithm that the truststore uses.  
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 | Default Value | Required  
---|---|---|---|---  
Path to the keystore. Mule resolves the path relative to the current classpath and file system.  
Type of keystore.  
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** |  Password used to protect the private key.  
Password used to protect the keystore.  
Encryption algorithm that the keystore uses.  
### Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  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** |  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** |  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.

  
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 of the OCSP responder.  
**Cert Alias** |  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 to the CRL file.  
### Definition Option
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The ID of the event definition expressed as a GUID (UUID). Required if not using a key.  
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** |  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 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 | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
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  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
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** |  Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  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 | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  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** |  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** |  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: |  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** |  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: |  Unit for the **In Memory Size** field.  
## See Also
  * Introduction to Anypoint Connectors
  * MuleSoft Help Center